aboutcode-org / aboutcode-org/scancode-toolkit

Documentation Inconsistencies/Improvements Tracker

Abierto
#1,813 4 comentarios 1 reacción 0 asignados Ver en GitHub
documentation long running new feature Priority: medium
Lenguaje dominante
Python
Estrellas
2.6k
Forks
791
Merge medio
1 d 12 h
PR fusionados (30 d)
5

Descripción

## **This Issue is to Track Documentation Inconsistencies in One Place.**

---

## 1. Issues Already Present

> Bugs/Other Inconsistencies

- [ ] Docs in Wiki Outdated [Add Disclaimer and Links to ReadTheDocs]
- [ ] Update Docs in Pypi Page
- [ ] Update README (mention ``pip install`` and Python 3 support)
- [ ] Check that all Links to Documentation in Various places point to ReadTheDocs (and not the Wikis)
- [ ] Take the information in [CONTRIBUTING.rst](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst) into the Contribute Section of [Docs](http://scancode-toolkit.readthedocs.io/).
- [ ] Take information from README.rst files in the source code folders , or link to them, in the docs.

---

## 2. CLI Options Marked as [ToDo] (For Improvement)

- [ ] ``--license-score`` [Basic Options] nexB/aboutcode#28
- [ ] ``--generated`` [Basic Options]
- [ ] ``--reindex-licenses`` [Core Options]
- [ ] ``--license-clarity-score`` [Post Scan Options]

---

## 3. Issues after an Upgrade/Solved Issue

> Docs That Will be inconsistent after a new feature (which is currently WIP/requested)

- [ ] Moving out ``samples`` folder. #1031 #1286
- [ ] Including Python 3 in Installer #1703
- [ ] Update Plugins Doc related to #1815
- [ ] Update Installation info to include Python 3.7 and 3.8 #1819
- [ ] Update Issue Templates with Links https://github.com/nexB/aboutcode/pull/33 #1827
- [ ] Remove warnings from docs after these are solved - #1758 #1759
- [ ] Update all docs with link to the getting started page https://github.com/nexB/aboutcode/pull/33

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.