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

Move documentation to GitHub #59

Merged
merged 15 commits into from
Dec 16, 2023

Conversation

MarkEWaite
Copy link
Contributor

Move documentation to GitHub

  • Migrate docs to GitHub
  • Try different layout for image examples
  • Use code formatting for syntax examples
  • Remove the since statements
  • Group methods with headings
  • Add more method headings
  • Hide the REST API documentation, not verified
  • Another attempt to comment out a block
  • Remove the REST description
  • Shorter message to match
  • Narrower example
  • Updates and corrections in changelog
  • Optimize images

Testing done

Confirmed that the documentation is no worse than the earlier documentation from the wiki. Many improvements are still possible and desirable, but this set of changes is a step forward.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes

@MarkEWaite MarkEWaite requested a review from a team as a code owner December 16, 2023 19:00
@MarkEWaite MarkEWaite added the documentation Improvements or additions to documentation label Dec 16, 2023
@MarkEWaite MarkEWaite enabled auto-merge (squash) December 16, 2023 19:01
@MarkEWaite MarkEWaite merged commit ff14631 into jenkinsci:master Dec 16, 2023
12 of 13 checks passed
@MarkEWaite MarkEWaite deleted the migrate-docs-to-github branch December 16, 2023 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant