Closed Bug 1331627 Opened 9 years ago Closed 9 years ago

Outline the documentation structure

Categories

(Cloud Services Graveyard :: Metrics: Pipeline, defect, P1)

Product:
Cloud Services Graveyard
Component:
Metrics: Pipeline
Type:
defect

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: harter, Assigned: harter)

References

Details

We want to create an outline of the comprehensive documentation so we can identify what's in and out of scope. Once we have an outline, we can get feedback from the team to see if anything is missing.
Updating this thread, I'm working on an outline of our documentation needs in the "outline" brance [2] of this repository [1]. I hope to have something to get feedback on by next week. For now, I'm using the gitbook toolchain but that's easy enough to change later. [1] https://github.com/harterrt/telemetry-docs [2] https://github.com/harterrt/telemetry-docs/tree/outline
I have a skeleton documentation hosted here[0]. Comments are very welcome. Feel free to comment on this PR [1] if you'd like to comment on specific sections. Jannis, will you please give this a review? Currently, the tech stack is gitbook hosted on github pages. So far, I'm happy with this choice, but I do need to document some snags with deploying and reviewing work. [0] https://harterrt.github.io/telemetry-docs/ [1] https://github.com/harterrt/telemetry-docs/pull/1/files
Flags: needinfo?(jezdez)
Here's a PR incorporating all of the offline feedback I've gotten. I'll be merging this early next week. https://github.com/mozilla/firefox-data-docs/pull/1
Flags: needinfo?(jezdez)
Status: NEW → RESOLVED
Closed: 9 years ago
Resolution: --- → FIXED
Product: Cloud Services → Cloud Services Graveyard
You need to log in before you can comment on or make changes to this bug.