Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hacktoberfest: migrate docs to github #75

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

kaltepeter
Copy link

Following this blog post: https://www.jenkins.io/blog/2019/10/21/plugin-docs-on-github/ I would like to migrate documentation to GitHub. Fixes: jenkins-infra/jenkins.io#3789

@kaltepeter kaltepeter force-pushed the migrate-docs-to-github branch from 139c0b0 to 87bbbcb Compare October 14, 2020 16:33
@kaltepeter kaltepeter force-pushed the migrate-docs-to-github branch from 87bbbcb to 07b9680 Compare October 14, 2020 16:34
Copy link

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer to have no wiki links inside the documentation if possible. In this case, the links can all be provided by the plugins site.

Thanks for the pull request!

Definitely worthy of the hacktoberfest-accepted label. Thanks

README.md Outdated

You can :

- Select the Docker image to run the build as a **Docker image** to be pulled. This is comparable to the [docker-plugin](https://wiki.jenkins.io/display/JENKINS/Docker+Plugin) approach to offer docker agents within Jenkins, but without any prerequisites on the Docker image nor need for Administrator privileges to configure the adequate agent template.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would prefer that we refer to the plugins site rather than the wiki for references to other plugins.

Suggested change
- Select the Docker image to run the build as a **Docker image** to be pulled. This is comparable to the [docker-plugin](https://wiki.jenkins.io/display/JENKINS/Docker+Plugin) approach to offer docker agents within Jenkins, but without any prerequisites on the Docker image nor need for Administrator privileges to configure the adequate agent template.
- Select the Docker image to run the build as a **Docker image** to be pulled. This is comparable to the [docker-plugin](https://plugins.jenkins.io/docker-plugin/) approach to offer docker agents within Jenkins, but without any prerequisites on the Docker image nor need for Administrator privileges to configure the adequate agent template.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, i will fix.

README.md Outdated

### Using Docker image

CloudBees Docker Custom Build Environment let you use arbitrary docker image to host the build. You can use such an image you build on your own (or using [CloudBees Docker Build and Publish](https://wiki.jenkins.io/display/JENKINS/Docker+build+publish+Plugin) plugin) to define the set of prerequisites for your project and share with the development team, as well as reuse for your CI job. In

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer to link to the plugins site rather than the wiki.

Suggested change
CloudBees Docker Custom Build Environment let you use arbitrary docker image to host the build. You can use such an image you build on your own (or using [CloudBees Docker Build and Publish](https://wiki.jenkins.io/display/JENKINS/Docker+build+publish+Plugin) plugin) to define the set of prerequisites for your project and share with the development team, as well as reuse for your CI job. In
CloudBees Docker Custom Build Environment let you use arbitrary docker image to host the build. You can use such an image you build on your own (or using [CloudBees Docker Build and Publish](https://plugins.jenkins.io/docker-build-publish/) plugin) to define the set of prerequisites for your project and share with the development team, as well as reuse for your CI job. In

README.md Outdated

## Advanced options

CloudBees Docker Custom Build Environment integrates with [Docker-commons](https://wiki.jenkins.io/display/JENKINS/Docker+Commons+Plugin) plugin so you can define the docker cli executable to be used to interact with Docker daemon, as well as select TLS credentials to be used to access a secured infrastructure (which is highly recommended)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer to refer to the plugins site.

Suggested change
CloudBees Docker Custom Build Environment integrates with [Docker-commons](https://wiki.jenkins.io/display/JENKINS/Docker+Commons+Plugin) plugin so you can define the docker cli executable to be used to interact with Docker daemon, as well as select TLS credentials to be used to access a secured infrastructure (which is highly recommended)
CloudBees Docker Custom Build Environment integrates with [Docker-commons](https://plugins.jenkins.io/docker-commons/) plugin so you can define the docker cli executable to be used to interact with Docker daemon, as well as select TLS credentials to be used to access a secured infrastructure (which is highly recommended)

README.md Outdated

### Comparison

Compared to [docker plugin](https://wiki.jenkins.io/display/JENKINS/Docker+Plugin),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer to use plugins site rather than wiki

Suggested change
Compared to [docker plugin](https://wiki.jenkins.io/display/JENKINS/Docker+Plugin),
Compared to [docker plugin](https://plugins.jenkins.io/docker-plugin/),

@kaltepeter
Copy link
Author

@MarkEWaite I believe I have resolved the issues with the wiki links. Thanks for the feedback.

Copy link

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They look great to me. Thanks @kaltepeter !

@oleg-nenashev do you or someone else need to label this pull request as hacktoberfest-accepted?

@oleg-nenashev
Copy link
Member

I added the label, have not reviewed the content yet

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @kaltepeter ! Just a few minor change suggestions

The plugin renaming was not consistent, would be great to fix it during the migration. Also, there is one "slave" occurrence which could be cleaned up.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
kaltepeter and others added 7 commits October 23, 2020 16:26
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Co-authored-by: Oleg Nenashev <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate 'Docker Custom Build Environment Plugin' docs to GitHub
4 participants