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

Move from doc-warden to an off-the-shelf markdown linter #1896

Open
4 tasks
scbedd opened this issue Aug 11, 2021 · 5 comments
Open
4 tasks

Move from doc-warden to an off-the-shelf markdown linter #1896

scbedd opened this issue Aug 11, 2021 · 5 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team.

Comments

@scbedd
Copy link
Member

scbedd commented Aug 11, 2021

  • azure-sdk-for-java
  • azure-sdk-for-python
  • azure-sdk-for-js
  • azure-sdk-for-net

There is changelog verification as part of the release process now.

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Aug 11, 2021
@weshaggard
Copy link
Member

We might consider retiring doc-warden all together and implementing some more common MD linting tools which I've been told (but not verified) can help with general readme formatting and structure.

@kurtzeborn kurtzeborn added Central-EngSys This issue is owned by the Engineering System team. and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Aug 17, 2021
@kurtzeborn kurtzeborn assigned scbedd and chidozieononiwu and unassigned scbedd Aug 17, 2021
@chidozieononiwu
Copy link
Member

chidozieononiwu commented Sep 15, 2021

We can use Markdown Linter to replace DocWarden.
It has this rule which can be used to enforce the required headers, there is also the ability to specify files to be omitted
I think those are the main things being provided by Docwarden. @scbedd Is that right?

@scbedd
Copy link
Member Author

scbedd commented Sep 16, 2021

doc-warden currently supports any pattern of headers. Check the .net .docsettings .

Notice the

and under header Y, we also have sections X, Z

@heaths
Copy link
Member

heaths commented Nov 29, 2022

Markdown Linter that @chidozieononiwu referenced is part of the Microsoft Docs Extension Pack for VS code, which Microsoft Docs (now Learn) recommends you install. Many of those components are also used in the pipeline that Docs uses, so could we talk to them and maybe align on that such that all our docs across Microsoft properties (e.g. .NET, various SDKs, general Docs, samples, etc.) are using the same set of rules?

@kurtzeborn
Copy link
Member

The title of this issue is misleading. The likely best outcome from this issue that we transition away from doc-warden to an off-the-shelf MD linter.

@kurtzeborn kurtzeborn moved this from 🤔 Triage to 📋 Backlog in Azure SDK EngSys 🚢🎉 Jul 10, 2023
@danieljurek danieljurek changed the title Disable doc-warden changelog verification Move from doc-warden to an off-the-shelf markdown linter Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team.
Projects
Status: 📋 Backlog
Development

No branches or pull requests

7 participants