jenkins.io icon indicating copy to clipboard operation
jenkins.io copied to clipboard

Convert 'Jenkins CLI' wiki page to jenkins.io

Open MarkEWaite opened this issue 4 years ago • 4 comments

Use the documentation page conversion instructions to convert Jenkins CLI from the wiki to jenkins.io.

MarkEWaite avatar May 08 '20 03:05 MarkEWaite

I reviewed both the pages on wiki.jenkins https://wiki.jenkins.io/display/JENKINS//Jenkins+CLI and jenkins.io https://www.jenkins.io/doc/book/managing/cli/ and the only sections that are not migrated are the following:

  • Getting help
  • Extending the CLI
  • Working with Credentials (divided further by version)
  • Connection mechanism

I just want to make sure these are relevant and up-to-date. OR should I go ahead and move it and then reviewers can review it in the pull request?

urwa avatar May 28 '20 07:05 urwa

The "Getting help" section should be migrated. Many users forget that the online help is available and can provide them answers to their questions.

The "Extending the CLI" does not need to be migrated.

The "Working with credentials" needs to be collapsed into a single block of text (no need for the version specifics in it) and then be compared with the page contents already at https://www.jenkins.io/doc/book/managing/cli/

Thanks so much for reviewing that content so well!

MarkEWaite avatar May 29 '20 15:05 MarkEWaite

At CloudBees, we recently updated the organization and content of our Jenkins CLI tool docs. If it would be helpful here is a link: https://docs.cloudbees.com/docs/admin-resources/latest/cli-guide/cli-guide-intro

Just make sure you adjust the content for Jenkins OSS and make a note at the bottom of the page attributing the content's origin to our site as we have done on this page where we used content from Jenkins.io - https://docs.cloudbees.com/docs/admin-resources/latest/pipelines-user-guide/pipeline-best-practices

HCloward avatar Jun 29 '20 15:06 HCloward

Thanks @HCloward . We'll likely need an asciidoc macro that will display the attribution consistently for any pages derived from sources outside of jenkins.io. Discussion is in the Jenkins documentation mailing list.

MarkEWaite avatar Jun 29 '20 15:06 MarkEWaite