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

Spring clean bedrock documentation #11390

Open
1 task
alexgibson opened this issue Mar 29, 2022 · 2 comments
Open
1 task

Spring clean bedrock documentation #11390

alexgibson opened this issue Mar 29, 2022 · 2 comments
Labels
Documentation Things related to the bedrock documentation

Comments

@alexgibson
Copy link
Member

Description

There's quite a lot of different pages in the bedrock docs that have been changed incrementally over time. It would be nice to take a high level pass over the documentation as a whole to try and fix some low hanging fruit:

  • Could the overall structure be organised in a better way that makes things easier to find?
  • Fix typos / broken links (link rot etc).
  • Fix any formatting errors where info is not displayed correctly.
  • Remove outdated or obsolete information.

Success Criteria

  • Existing documentation is audited for the above.
@alexgibson alexgibson added the Documentation Things related to the bedrock documentation label Mar 29, 2022
@maureenlholland
Copy link
Contributor

maureenlholland commented Apr 11, 2022

Re: broken links, before I forget about it, want to note "system path" 404

https://bedrock.readthedocs.io/en/latest/testing.html#running-functional-tests:
To run the tests using Firefox, you must also first download geckodriver and make it available in your system path.

More broken links:
https://bedrock.readthedocs.io/en/latest/testing.html#running-jasmine-tests-using-karma
broken: https://jasmine.github.io/1.3/introduction.html

https://bedrock.readthedocs.io/en/latest/testing.html#headless-tests
broken: https://github.com/mozilla/bedrock/blob/main/tests/functional/test_download_l10n.py

broken: https://bedrock.readthedocs.io/en/latest/stub-attribution.html (must be a leftover reference somewhere before the page was called /firefox-stub-attribution)

@reemhamz
Copy link
Contributor

reemhamz commented May 13, 2022

I think it would be a good idea to start meshing information in some parts of the documentation with how we handle things in their Protocol macro counterparts. For example, it took me and Maureen a bit to see how to use l10n_img helper with Protocol macros. I was personally referencing the helper's section in the docs. I couldn't find any macro utilizing that helper in our codebase and kept getting different errors trying out different syntax for using the helper. We then came to realize it was a boolean parameter macros and figured it out from there.

Though I could have scoured the appropriate part of docs first-thing (l10n_img is mentioned as a boolean here https://bedrock.readthedocs.io/en/latest/coding.html#split), it would have been a little less work if the l10n_img subsection just quickly mentioned how we handled things in our macros.
It would just be a nicer idea to create less friction when referincing how some helpers are used under their main/respective section in the docs, especially since macros are very heavily used in Bedrock now :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Things related to the bedrock documentation
Projects
None yet
Development

No branches or pull requests

3 participants