documentation updates (demos, contributors, etc)

This commit is contained in:
Ewelina Wilkosz 2018-02-02 15:11:55 +01:00
parent 2c69a83f62
commit a0720f70ee
4 changed files with 43 additions and 18 deletions

View File

@ -1,8 +1,12 @@
# artifactory plugin
Artifactory plugin configuration belongs under `jenkins` root element
## sample configuration
```yaml
jenkins:
[...]
artifactorybuilder:
useCredentialsPlugin: true
artifactoryServers:
@ -18,4 +22,3 @@ artifactorybuilder:
Currently setting credentials causes ERROR & `Enable Push to Bintray` is not supported (always enabled).
see [https://www.jfrog.com/jira/browse/HAP-1018]

View File

@ -1,6 +1,11 @@
# configure jenkins
Basic Jenkins configuration, which is not a part of any plugin
Basic Jenkins configuration under `Configure System`, which is not a part of any plugin
Many of the plugins are actually configured in the same section, so to configure them you'll put their configuration also under `jenkins` root element - details in plugin specific subfolders.
[jenkins.yaml](jenkins.yaml) file is an example of configuration file with Jenkins and a number of plugins configured.
## sample configuration

View File

@ -1,7 +1,24 @@
# How to contribute your changes to the plugins
# Contribution guide
## Why should you contribute?
You can contribute in many ways, and whatever you choose we're grateful!
Source code contribution is the obvious one but we also need your feedback and if you don't really want to participate in the implementation directly you may still have great ideas about features we need (or should get rid of).
We have our vision for the plugin and we have an experience with maintaining Jenkins instances, but the plugin is not supposed to solve only our problems. Surely we haven't experienced all of them... That's why we want to hear from you.
Please use github issues if you need to report a bug or request changes/improvements.
Whenever you report a problem please provide information about:
- Plugin version (Configuration as Code plugin as well any other plugin you suspect your problem to be related to)
- Jenkins version
- Operating system
- Description!
### Regarding source code contribution WoW:
1. Create a github issue for your feature/problem you want to solve
2. Implement solution on a branch in your fork
3. Once you're done create Pull Request and ask at least one of the maintainers for review (@ndeloof, @ewelinawilkosz)
3. Make sure to include issue number in commit message, and make the message speak for itself
4. Once you're done create Pull Request and ask at least one of the maintainers for review (@ndeloof, @ewelinawilkosz)
!! Never push directly to this repository

View File

@ -5,10 +5,6 @@ Or maybe you're not feeling confident enough with the change you have in mind?
Jenkins Configuration as Code solves both problems - you don't need to access Jenkins to implement a change and you can always revert to previous version of configuration (if you keep your configuration under version control)
## [NOT SUPPORTED YET] Export existing configuration
To be able to do that - once it becomes supported feature - you need to install the plugin manually on your working Jenkins instance and use export function.
## Create jenkins.yaml from scratch
We've decided to use yaml format so writing the configuration "by hand" should be easy. Your existing Jenkins can be also used as a documentation - yaml file tries to mimic UI you're used to as much as possible.
@ -17,3 +13,7 @@ Plugin provides documentation generated for your specific Jenkins instance - aft
http://[your_jenkins_url]/plugin/configuration-as-code/
Various samples of plugins' configuration can be found in [demos](../demos) folder
## [NOT SUPPORTED YET] Export existing configuration
To be able to do that - once it becomes supported feature - you need to install the plugin manually on your working Jenkins instance and use export function.