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

[chore] Highlight docs which are draft, WIP, out-of-date, etc. #83

Open
andrewnicols opened this issue Apr 28, 2022 · 1 comment
Open
Labels
help wanted Extra attention is needed repo

Comments

@andrewnicols
Copy link
Member

What do we need to do?

Identify documents in various state in the front-matter and turn this into a page banner with links to contributing to docs, etc.

For example:

---
title: Question bank
draft:
  issueNumber: 99
  trackerIssue: MDL-12345
tags:
  - draft
---

Could be turned into a banner which links to the devdocs issue with information, and the Tracker issue (if relevant), and provides links to the devdocs contributing docs, etc.

Similarly a Draft tag could warn users that this page is a draft and may not be complete, and to see issue # for more information or provide feedback.

@sarjona
Copy link
Member

sarjona commented Apr 28, 2022

Hi Andrew!

Thanks for raising this! It seems that docusaurus let mark documents as draft using draft: true: facebook/docusaurus#6457

However, when they are marked as draft, they won't be deployed or displayed in the sidebars. So, depending on the page, I think the draft tag is also a great idea (and a good way to identify and find pages to be improved).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed repo
Projects
None yet
Development

No branches or pull requests

2 participants