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.

Sign up for GitHub

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

Jump to bottom

Gaia Docs Restructure #2309

Open
28 of 67 tasks
mmulji-ic opened this issue Mar 17, 2023 · 0 comments
Open
28 of 67 tasks

Gaia Docs Restructure #2309

mmulji-ic opened this issue Mar 17, 2023 · 0 comments
Assignees
@MSalopek
Labels
admin: epic An EPIC -- meta issue used to track a body of work admin: key-result A key result (in the context of OKRs) S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability scope: docs Improvements or additions to documentation

Comments

@mmulji-ic
Copy link
Contributor

mmulji-ic commented Mar 17, 2023 •
edited

Problem

Gaia docs needs an upgrade. There is too much duplication and out of date material.
This epic aims to restructure and plan updates to the current set of docs and related sites.

Task list

By Quarter

Q2 task list
Beta Give feedback
  1. Interview validators and node operators to better understand their documentation needs (preet) #2630
    scope: docs
    mmulji-ic
  2. feat: Migrate docs from Vuepress to Docusaurus #2066
    S: ImprovingThings scope: docs
    mmulji-ic
  3. feat: Update docs to display older versions of Gaia docs #2065
    S: ImprovingThings scope: docs
    MSalopek
  4. Survey of docs structure of major Cosmos projects #2364
    S: ImprovingThings scope: docs
    mmulji-ic
  5. Survey of docs structure of alternate Blockchain ecosystem projects #2363
    scope: docs
    mmulji-ic
  6. Draft persona documents (preet) #2464
    0 of 7
    S: ImprovingThings scope: docs
    mmulji-ic
  7. Update CONTRIBUTING.md to be consistent with the new process #2371
    scope: docs
    mpoke
  9. Update SECURITY.md #2398

Q3 task list
Beta Give feedback
  6. docs: create a Features doc #1668
    S: ImprovingThings scope: docs
  7. Create docs meta-sitemap #2362
    S: ImprovingThings scope: docs
    mmulji-ic
  8. Draft document layout templates (aaron) #2465
    0 of 2
    S: ImprovingThings scope: docs
    mmulji-ic
  9. Draft IA and Sitemap #2466
    S: ImprovingThings scope: docs
  10. Hub branding, palette scheme #2467
    0 of 2
    S: ImprovingThings scope: docs

Q4 task list
Beta Give feedback
  1. Review feedback sessions with stakeholders (ICF, comms and marketing, validators, core teams) #2468
    S: ImprovingThings scope: docs

By Category

Docs Platform
Beta Give feedback
  1. feat: Migrate docs from Vuepress to Docusaurus #2066
    S: ImprovingThings scope: docs
    mmulji-ic
  2. feat: Update docs to display older versions of Gaia docs #2065
    S: ImprovingThings scope: docs
    MSalopek

Information Architecture / Design
Beta Give feedback
  1. Document use/relevance of Other code/resources/docs websites in the Cosmos org #2361
    S: ImprovingThings scope: docs
    mmulji-ic
  2. Create docs meta-sitemap #2362
    S: ImprovingThings scope: docs
    mmulji-ic
  3. Survey of docs structure of major Cosmos projects #2364
    S: ImprovingThings scope: docs
    mmulji-ic
  4. Survey of docs structure of alternate Blockchain ecosystem projects #2363
    scope: docs
    mmulji-ic
  5. Draft persona documents (preet) #2464
    0 of 7
    S: ImprovingThings scope: docs
    mmulji-ic
  6. Draft document layout templates (aaron) #2465
    0 of 2
    S: ImprovingThings scope: docs
    mmulji-ic
  7. Draft IA and Sitemap #2466
    S: ImprovingThings scope: docs
  8. Hub branding, palette scheme #2467
    0 of 2
    S: ImprovingThings scope: docs
  9. Review feedback sessions with stakeholders (ICF, comms and marketing, validators, core teams) #2468
    S: ImprovingThings scope: docs

Restructuring Ideas
Beta Give feedback
  1. docs: Gaia Docs Upgrade needs a facelift #1794
    S: ImprovingThings other: decayed scope: docs type: tech-debt
    mmulji-ic
  2. docs: create a Features doc #1668
    S: ImprovingThings scope: docs

Developer / Community Related Guidelines
Beta Give feedback
  1. Update CONTRIBUTING.md to be consistent with the new process #2371
    scope: docs
    mpoke
  3. Update SECURITY.md #2398

Other code/resources/docs websites
Beta Give feedback

REST API playground
Beta Give feedback

Introduction & Getting Started
Beta Give feedback
No tasks being tracked yet.

Gaia Tutorials
Beta Give feedback
No tasks being tracked yet.

Delegators
Beta Give feedback
No tasks being tracked yet.

Validators
Beta Give feedback
No tasks being tracked yet.

Governance
Beta Give feedback
No tasks being tracked yet.

Roadmap & Previous Releases
Beta Give feedback
No tasks being tracked yet.

Migration Instructions
Beta Give feedback
No tasks being tracked yet.

ADR's
Beta Give feedback
No tasks being tracked yet.

Gaia Modules
Beta Give feedback
No tasks being tracked yet.

Nice to have
Beta Give feedback
  1. Update references to the mainnet repo for Gaia docs #2064
    scope: docs
    mmulji-ic
  2. Ensure documentation for kms usage is present and clear #662
    S: ImprovingThings other: decayed scope: docs
    MSalopek
@mmulji-ic mmulji-ic added admin: epic An EPIC -- meta issue used to track a body of work status: waiting-triage This issue/PR has not yet been triaged by the team. labels Mar 17, 2023
@mpoke mpoke added scope: docs Improvements or additions to documentation and removed status: waiting-triage This issue/PR has not yet been triaged by the team. labels Mar 17, 2023
@mmulji-ic mmulji-ic added the admin: key-result A key result (in the context of OKRs) label Mar 17, 2023
@MSalopek MSalopek mentioned this issue Apr 20, 2023
Closed
@mpoke mpoke added the S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability label Sep 14, 2023
@mmulji-ic mmulji-ic mentioned this issue Nov 21, 2023
Closed
12 tasks
@MSalopek MSalopek assigned MSalopek and unassigned mmulji-ic Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MSalopek MSalopek

Labels
admin: epic An EPIC -- meta issue used to track a body of work admin: key-result A key result (in the context of OKRs) S: ImprovingThings Improving things: Customer requests, performance improvements, reliability and usability scope: docs Improvements or additions to documentation
Projects
Cosmos Hub
Status: 🏗 F3: InProgress
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mpoke @MSalopek @mmulji-ic