timgent
commented
4 years ago Planned approach
- Setup docosaurus static generation - DONE
- Get it to use some mdoc source files in the docosaurus generated pages - DONE
- Use mdoc docosaurus plugins to generate the site - DONE
- Publish to Github Pages locally
- using docosaurus script rather than mdoc script which does more. Current one uses local github user - DONE
- Publish locally using deploy key - DONE
- Publish to Github Pages as part of CI on master branch - DONE
- This might help... https://github.com/marketplace/actions/webfactory-ssh-agent
- Setup site so it redirects straight to documentation page - DONE
- Actually write some documentation...!
- Come up with structure and get that working properly on the site - DONE
- Complete each section...!
- Getting Started and intro - DONE
- Metrics based checks - DONE
- Arbitrary checks - DONE
- Deequ-based checks - SPLIT OUT TO SEPARATE TICKET
- Persisting results from checks - DONE
- Persisting metrics over time - DONE
- Developer docs - add how to spin up temporary ElasticSearch and run the unit tests - DONE
- Customise headers, footers, anything else that looks out of place - DONE
Use https://github.com/scalameta/mdoc