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

Add guidelines to addin best practices for best docs integration #2242

Open
pascalberger opened this issue Oct 19, 2021 · 0 comments
Open

Add guidelines to addin best practices for best docs integration #2242

pascalberger opened this issue Oct 19, 2021 · 0 comments

Comments

@pascalberger
Copy link
Member

We currently already have a short section how to document addins: https://cakebuild.net/docs/extending/addins/best-practices#documentation

AliasCategory tags are only used for integrating documentation on website and we should enhance the best practices with guidelines how we expect categories to be set for best integration into https://cakebuild.net/dsl/ and how NuGet package tags should be set for best integration into https://cakebuild.net/extensions/.

The basic idea of current website is to have an Extensions page which lists all extensions (currently addins & modules). On every extension page we list all aliases provided by the specific extension (e.g. https://cakebuild.net/extensions/cake-azuredevops/). Extension page allows to filter on extension type, name and tags.
The reference page lists all aliases, built-in and aliases provided by addins, grouped by category. It allows to filter the categories on name. There is also a full text search available across all aliases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant