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

Migrate documentation to MkDocs #228

Closed
wants to merge 72 commits into from

Conversation

oleg-nenashev
Copy link
Member

@oleg-nenashev oleg-nenashev commented Nov 20, 2023

For #24 . This is a big WiP prototype

Closes:

Other key features

  • Search
  • Better Mobile navigation

Preview

https://oleg-nenashev.github.io/wiremock.org/

image

TODOs

  • Initial MkDocs setup
  • Split and relocate images
  • Move code tabs to the native engine
  • Setup CI
  • Setup staging site
  • Fix redirects within docs
  • Fix images
  • Ensure section links and breadcrumbs work fine
  • Fix sitemap generation for docs
  • Fix Docs Landing page rendering or move it back to the Jekyll site
  • Fix Header and Footer
  • Add OpenGraph rendering
  • Fix OpenAPI specification rendering and source it from the repo
  • Fix version number rendering/propagation to MkDocs
  • Move events pages to the new engine
  • Move external resources to the new engine
  • Configure Google Analytics
  • Configure MS Clarity (Custom script needed)
  • Align the header with the old website
  • Move Support pages to the documentation engine
  • Fix the docs site header on mobile screens

Production deployment TODO

  • Update deployment pipelines to follow staging
  • Update Google Analytics and Clarity tags

Submitter checklist

  • The PR request is well described and justified, including the body and the references
  • The PR title represents the desired changelog entry
  • If the change against WireMock 2 functionality (incompatible with WireMock 3),
    it is submitted against the 2.x branch
  • The repository's code style is followed (see the contributing guide)

Details: Contributor Guide

@oleg-nenashev oleg-nenashev added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 21, 2023
@tomakehurst
Copy link
Member

Great progress so far.

A couple of bits of feedback:

  • It would be great if the in-page nav was in a panel on the right rather than integrated into the LH nav.
  • Would also be great to have a anchor links on the page titles (like you added to the current docs)

@oleg-nenashev oleg-nenashev marked this pull request as ready for review December 10, 2023 17:25
@tomakehurst
Copy link
Member

Closing this as it's been merged and superseded via branching

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 enhancement New feature or request
Projects
Status: 🚀 Released
2 participants