Hi Mark Have you got any examples of documentation that would be good to migrate?
Sounds great though Thanks Tim On Tue, 23 Jun 2020 at 22:39, Mark Waite <[email protected]> wrote: > The documentation team at CloudBees has asked if the community would be > interested in reworking or adjusting documentation that CloudBees has > created for their product to describe similar use cases on www.jenkins.io. > The documentation team at CloudBees does not have the capacity to perform > the transformation themselves, but would be happy to allow others to use > their material, validate that it works with the most recent Jenkins LTS, > update the screenshots to use Jenkins rather than the CloudBees product, > and submit it as a pull request to the Jenkins documentation. > > I envision that the process would be similar to our Wiki migration > process. I think it would work something like this: > > - A CloudBees documentation team member creates a GitHub issue for > content that could be reworked or reused on www.jenkins.io. The > GitHub issue provides the source text and images for reference or provides > a link to a publicly accessible location that includes the source text and > images > - A Jenkins contributor adds a comment to the GitHub issue that says, > "I'm working on this" > - The Jenkins contributor uses the CloudBees ASCIIDOC, adjusts the > phrasing as needed to apply to Jenkins, confirms that it works with > Jenkins, and updates any screenshots to use Jenkins > - The Jenkins contributor adds an attribution to CloudBees (per the > Creative Commons SA 4.0 license) to the bottom of the page submitted for > www.jenkins.io > - The Jenkins contributor submits a pull request and the changes are > reviewed in the usual pull request review process > > I believe the same process could be used by any company that delivers > products based on Jenkins. > > Some of the questions that arise for me: > > - Is that type of process within the bounds of the www.jenkins.io > licensing? > - Does this need a JEP or is it sufficient to discuss on the > developers list? > - Are there any special approvals required for this type of content? > - Are there issues or concerns with the technique? > > Some questions that others might ask: > > - Why not just ask the CloudBees documentation team to submit the pull > request to www.jenkins.io themselves? > > Their focus is on documenting their commercial product for their > commercial customers. They are willing to share their content with the > Jenkins community, but they can't take the time to rework their content for > use in the www.jenkins.io site. If the community would like to use > the content, they are welcome to do so > > - Who will review the pull requests and mentor the contributors? > > The same people that are currently reviewing pull requests will review > these as well > > I'd like to discuss this here in the developers list with the assumption > that if there are significant issues or questions, we work through them > here on the list. If we don't detect significant issues, then I'd bring > the topic to a governance meeting to confirm that the Jenkins Board is OK > with the idea. > > Thanks, > Mark Waite > > -- > You received this message because you are subscribed to the Google Groups > "Jenkins Developers" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/jenkinsci-dev/b47ca50d-685d-4713-907c-adab5f5ba416n%40googlegroups.com > <https://groups.google.com/d/msgid/jenkinsci-dev/b47ca50d-685d-4713-907c-adab5f5ba416n%40googlegroups.com?utm_medium=email&utm_source=footer> > . > -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CAH-3Bie9y2fE4BxqneF6U-A%3D%3DSUkyrior6ZqL4YZNuoN1sqPew%40mail.gmail.com.
