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

[GEOS-11221] mkdocs #7462

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open

Conversation

jodygarnett
Copy link
Member

@jodygarnett jodygarnett commented Mar 9, 2024

GEOS-11221 Powered by Pull Request Badge

Proposal: GSIP-221

  • migrated markdown user guide documentation
  • mkdocs.yml configuration
  • source remains unchanged to allow mkdocs_translate script to be reused to correct specific files
  • Fix reported migration problems
  • build.xml update to call mkdocs

GSIP-221 pull-requests

main:

2.25.x:

  • [Backport 2.25.x] [GEOS-11221] mkdocs

2.24.x:

Checklist

For core and extension modules:

  • New unit tests have been added covering the changes.
  • Documentation has been updated (if change is visible to end users).
  • The REST API docs have been updated (when changing configuration objects or the REST controllers).
  • There is an issue in the GeoServer Jira (except for changes that do not affect administrators or end users in any way).
  • Commit message(s) must be in the form [GEOS-XYZWV] Title of the Jira ticket.
  • Bug fixes and small new features are presented as a single commit.
  • Each commit has a single objective (if there are multiple commits, each has a separate JIRA ticket describing its goal).

@jodygarnett jodygarnett changed the title [GEOS-11221] mkdocsa[GEOS-11221] mkdocs [GEOS-11221] mkdocs Mar 9, 2024
@jodygarnett jodygarnett force-pushed the mkdocs-main branch 2 times, most recently from 854e6e6 to f428f38 Compare March 9, 2024 06:08
@aaime
Copy link
Member

aaime commented Mar 11, 2024

There are still many pages with "problems" marked in the sheet here (aka known problems):
https://docs.google.com/spreadsheets/d/1HMqUpTirEwwSQfeNYikPjU0aFMl0-W4Xj44cg8V_VJA/edit#gid=0

@jodygarnett
Copy link
Member Author

jodygarnett commented Mar 11, 2024

There are still many pages with "problems" marked in the sheet here (aka known problems): https://docs.google.com/spreadsheets/d/1HMqUpTirEwwSQfeNYikPjU0aFMl0-W4Xj44cg8V_VJA/edit#gid=0

Yes I indicated in email I would fix reported problems first, added to checklist

@jodygarnett jodygarnett force-pushed the mkdocs-main branch 2 times, most recently from db9509c to 9559154 Compare March 12, 2024 06:36
@jodygarnett
Copy link
Member Author

discussion actions since this missed the release candidate window:

  • remove the generated markdown results
  • would allow this PR can focus on cleaning up the rst files so we get a clean conversion

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