-
Notifications
You must be signed in to change notification settings - Fork 26
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
Bug 1894945 - new Glean.js docs platform MVP #1920
Conversation
changelog - create custom PageTitle component with telemetry built in - update astro config for new skeleton + component override
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a couple of nits, but this is looking good!
documentation/src/content/docs/automatic_instrumentation/why.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your patience in waiting for me to take a gander. I like the structure and the implementation and can't wait to see how easy it'll be to edit and write new docs.
I do have (checks notes) 18 things to say about the PR, but I don't think there's a single one that should stop us from publishing it right away if you think it's best.
Thank you both for the reviews! I made many changes based on the feedback you provided and you caught a lot of stuff that needed to be addressed now or in the future. I created a [meta] bug for all this work and made child bugs for things that were brought up during this review and some things that still need to be documented. |
This is a first pass of the new documentation platform. There is generated content in here about the major Glean.js features, but the documentation is not complete. There are other features/topics/things that will be documented.
Running the new docs
cd documentation npm i npm run dev
Pull Request checklist
glean/
folder, run:npm run test
Runs all testsnpm run lint
Runs all lintersCHANGELOG.md
or an explanation of why it does not need onemozilla/glean
repository