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

[DOC] - Audit docs and adapt to Diataxis framework #975

Closed
trallard opened this issue Dec 17, 2021 · 4 comments
Closed

[DOC] - Audit docs and adapt to Diataxis framework #975

trallard opened this issue Dec 17, 2021 · 4 comments
Assignees
@kcpevey
Labels
area: documentation 📖 Improvements or additions to documentation impact: high 🟥 This issue affects most of the nebari users or is a critical issue
Milestone
Future Planning

Comments

@trallard
Copy link
Member

Our documentation needs a lot of TLC 📖
For this purpose we will:

  1. Perform an audit on the existing docs to identify outdated content/gaps
  2. Align with the Diataxis framework to provide meaningful content for end-users/DevOps folks/ contributors and maintainers
  3. Develop a docs roadmap
@trallard trallard added area: documentation 📖 Improvements or additions to documentation Epic Roadmap 🚀 This item is part of our roadmap labels Dec 17, 2021
@trallard trallard self-assigned this Dec 17, 2021
@trallard trallard moved this to Needs Triage 🔍 in QHub Project Mangement 🚀 Dec 17, 2021
@trallard trallard added the impact: high 🟥 This issue affects most of the nebari users or is a critical issue label Dec 17, 2021
@trallard trallard moved this from Needs Triage 🔍 to Backlog 🏁 in QHub Project Mangement 🚀 Dec 17, 2021
@magsol magsol mentioned this issue Feb 1, 2022
Closed
15 tasks
@trallard trallard pinned this issue Feb 18, 2022
@trallard trallard unpinned this issue Feb 18, 2022
@trallard trallard mentioned this issue Feb 18, 2022
Closed
@costrouc costrouc added this to the Future Planning milestone May 5, 2022
@costrouc
Copy link
Member

costrouc commented May 5, 2022

This is a significant undertaking and we will need to plan for this. Moving to the future plans. We certainly agree this needs to be done.

@trallard trallard changed the title [documentation] - Audit docs and adapt to Diataxis framework [DOC] - Audit docs and adapt to Diataxis framework May 9, 2022
@trallard
Copy link
Member Author

trallard commented May 9, 2022

@kcpevey is going to be working on this with me - from scoping to planning

@trallard trallard moved this to Todo 📬 in 📖 - Documentation May 11, 2022
@kcpevey
Copy link
Contributor

kcpevey commented May 13, 2022

Working on this in notion

@trallard trallard moved this from Todo 📬 to In Progress 🏗 in 📖 - Documentation May 16, 2022
@trallard trallard removed area: documentation 📖 Improvements or additions to documentation Epic labels May 16, 2022
@trallard trallard removed impact: high 🟥 This issue affects most of the nebari users or is a critical issue Roadmap 🚀 This item is part of our roadmap labels May 16, 2022
@trallard trallard assigned kcpevey and unassigned trallard May 16, 2022
@trallard trallard moved this from Backlog 🏁 to In Progress 🏃🏽‍♀️ in QHub Project Mangement 🚀 May 17, 2022
@trallard trallard added the area: documentation 📖 Improvements or additions to documentation label May 17, 2022
@trallard trallard added Epic impact: high 🟥 This issue affects most of the nebari users or is a critical issue labels May 17, 2022
@trallard trallard moved this from In Progress 🏗 to Done 💪🏾 in 📖 - Documentation May 24, 2022
@trallard
Copy link
Member Author

We will mark this as completed since we have agreed on the main TOC and working on implementation

Repository owner moved this from In Progress 🏃🏽‍♀️ to Done 💪🏾 in QHub Project Mangement 🚀 May 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kcpevey kcpevey

Labels
area: documentation 📖 Improvements or additions to documentation impact: high 🟥 This issue affects most of the nebari users or is a critical issue
Projects
📖 - Documentation
Status: Done 💪🏾
Milestone
Future Planning
Development

No branches or pull requests
3 participants
@costrouc @kcpevey @trallard