Open Bug 1897880 Opened 2 years ago Updated 1 year ago

Migrate gleanjs /docs folder to new documentation

Categories

(Data Platform and Tools :: Glean: SDK, enhancement, P3)

enhancement

Tracking

(Not tracked)

People

(Reporter: brosa, Unassigned)

References

(Blocks 1 open bug)

Details

We need to migrate the /docs folder to our new documentation hosted at https://mozilla.github.io/glean.js/.

What we need to do

  1. Make a new automatically collapsible /dev section with the title of "Developer Docs"
  2. Copy all the existing docs over to the new section
  3. Delete the existing /docs folder
  4. Update this link: https://github.com/mozilla/glean.js?tab=readme-ov-file#gleanjs-developer-documentation

We should also remove any docs for things that are no longer true or are supported; like plugins.

https://github.com/mozilla/glean.js/pull/1939#discussion_r1607785975

Component: Glean Platform → Glean: SDK
You need to log in before you can comment on or make changes to this bug.