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

Replace wiki URL with github URL in pom files #2044

Merged
merged 1 commit into from
Jan 28, 2020

Conversation

kshultzCB
Copy link
Collaborator

@kshultzCB kshultzCB commented Jan 27, 2020

Update project.url in pom files for documentation migration project

Changes the document.url field in each submodules' pom.xml to point to instead of https://wiki.jenkins-ci.org/display/JENKINS/Blue+Ocean+Plugin. This is the same URL as put into the aggregator by @MarkEWaite in PR2040.

Submitter checklist

  • Link to JIRA ticket in description, if appropriate: N/A
  • Change is code complete and matches issue description
  • Appropriate unit or acceptance tests or explanation to why this change has no tests: N/A. Strictly a doc link change in pom files.
  • Reviewer's manual test instructions provided in PR description: there are none. Strictly a doc link change in pom files.

Reviewer checklist

  • Run the changes and verified the change matches the issue description
  • Reviewed the code
  • Verified that the appropriate tests have been written or valid explanation given

@dwnusbaum
Copy link
Member

@kshultzCB For something like this, where your PR requires another PR (the file https://github.com/jenkinsci/blueocean-plugin/blob/master/blueocean/doc/BlueOcean.adoc doesn't exist currently), you can start your PR using the other PR as the base, and then add commits on top of it and submit a PR that has the original commit in addition to your commits.

@olamy olamy merged commit 2b508ca into jenkinsci:master Jan 28, 2020
@MarkEWaite
Copy link
Contributor

MarkEWaite commented Jan 28, 2020

I'm a little surprised this was merged. Blue Ocean is composed of multiple plugins. I assumed in #2040 (comment) that each plugin would have its own adoc page which described the role of that specific plugin within the system that is "Blue Ocean".

Is this a temporary state where those documentation URLs for the component plugins will eventually be replaced by separate adoc pages or is this intended to be the final state?

I realize that it is much more work to provide an adoc description for each of the plugins that are released from this repository, but I thought that would be better for the user than having all the Blue Ocean plugin docs say the same thing.

@olamy
Copy link
Member

olamy commented Jan 28, 2020

As far I can see the current change is doing the same as today (i.e same page for all modules/plugins) so at this stage it's at least better :) as this is now a page we can update.
Sure that would be better let's see if we can find some people to contribute this documentation.

@MarkEWaite
Copy link
Contributor

Thanks for the clarification @olamy ! I had mistakenly assumed that there were already wiki pages for each of the blue ocean plugins.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants