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

Validate examples in configuration.md #84

Open
meowjesty opened this issue Jun 2, 2023 · 1 comment
Open

Validate examples in configuration.md #84

meowjesty opened this issue Jun 2, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@meowjesty
Copy link
Member

The Configuration page now has a bunch of examples, but they're not validated against anything, so if we add new stuff, or make changes the examples would be silently giving out wrong information.

I can think of a couple of ways to solve this:

  1. Leverage Rust documentation tests to load our config examples and check if they're valid;
  2. Use our documentation extraction tool (medschool) to spit out the examples, and validate the json we get;

Which one would be easier? Also, anyone can think of other approaches?

@meowjesty meowjesty added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Jun 2, 2023
@aviramha
Copy link
Member

I think we should add a "mirrord validate" command then we can use it here also, later on we can use it in the extension to verify before launching.

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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants