aboutcode-org / aboutcode-org/scancode-toolkit

Merge Tutorials and How-to Guides

Open
#1,980 2 comments 0 reactions 2 assignees Claimed by @johnmhoran View on GitHub
documentation Priority: low
Dominant language
Python
Stars
2.6k
Forks
791
Avg merge
1d 12h
Merged PRs (30d)
5

Description

We do not need separate top-level sections for Basic Tutorials and How-to Guides (esp. clear since most of the Basic Tutorials subsections are titled "How to....".
We should merge all of the content for these two sections under How-to Guides with "How to Add a New License" and "How to Add New License Rules after.." after "How to set what will be detected..".
"Add a Post-Scan Plugin" will be the last entry in How-to Guides.
We should also remove "How to " from the subsection titles since that will be covered by the Section title.
In the future we may want to separate the more technical How to sections like Add a License or Add a Post-Scan Plugin from the rest, but that is not necessary with the current amount of How-to content

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.