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

Bug 1894945 - new Glean.js docs platform MVP #1920

Merged
merged 49 commits into from May 3, 2024

Conversation

rosahbruno
Copy link
Contributor

@rosahbruno rosahbruno commented Apr 22, 2024

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

  • Quality: Make sure this PR builds and runs cleanly.
    • Inside the glean/ folder, run:
      • npm run test Runs all tests
      • npm run lint Runs all linters
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Changelog: This PR includes a changelog entry to CHANGELOG.md or an explanation of why it does not need one
  • Documentation: This PR includes documentation changes, an explanation of why it does not need that or a follow-up bug has been filed to do that work

@rosahbruno rosahbruno marked this pull request as ready for review April 25, 2024 20:06
@auto-assign auto-assign bot requested a review from Dexterp37 April 25, 2024 20:06
@Dexterp37 Dexterp37 removed their request for review April 26, 2024 08:32
Copy link
Member

@travis79 travis79 left a 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/.vscode/launch.json Show resolved Hide resolved
documentation/astro.config.mjs Outdated Show resolved Hide resolved
Copy link
Contributor

@chutten chutten left a 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.

documentation/.gitignore Show resolved Hide resolved
documentation/README.md Show resolved Hide resolved
documentation/astro.config.mjs Show resolved Hide resolved
documentation/public/favicon.svg Outdated Show resolved Hide resolved
documentation/src/assets/houston.webp Outdated Show resolved Hide resolved
documentation/src/content/docs/debugging/options.md Outdated Show resolved Hide resolved
documentation/src/content/docs/index.mdx Outdated Show resolved Hide resolved
documentation/src/content/docs/reference/sessions.md Outdated Show resolved Hide resolved
documentation/tsconfig.json Outdated Show resolved Hide resolved
@rosahbruno rosahbruno changed the title new Glean.js docs platform Bug 1894945 - new Glean.js docs platform MVP May 3, 2024
@rosahbruno
Copy link
Contributor Author

@travis79 @chutten

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.

https://bugzilla.mozilla.org/show_bug.cgi?id=1894943

@rosahbruno rosahbruno merged commit 38b60ca into mozilla:main May 3, 2024
5 of 6 checks passed
@rosahbruno rosahbruno deleted the gleanjs-docs branch May 3, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants