Skip to content

Commit a8813c4

Browse files
steven-essersteven-esser
authored
Merge pull request #34 from AyanSinhaMahapatra/master
Delete scancode-toolkit Documentation
2 parents faea9fc + 6c0e53d commit a8813c4

122 files changed

Lines changed: 156 additions & 7850 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/--doc-report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: "Documentation Improvement"
3+
about: Your suggestions for improving the Documentation.
4+
title: ''
5+
labels: 'documentation'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Please fill out as much of the below template and delete unnecessary text.
12+
Markdown Styling - https://commonmark.org/help/
13+
-->
14+
15+
### Description
16+
17+
> A brief description of the Documentation Improvement or New Section request.
18+
19+
20+
### Link to Documentation Page
21+
22+
> Where the confusion/inconsistency/incomplete documentation is.
23+
24+
<!--
25+
Link to Specific Aboutcode Documentation Page from http://aboutcode.readthedocs.io/
26+
-->
27+
28+
### Select Category
29+
<!-- Which of this label correctly describe your Bug Report -->
30+
31+
- Inconsistency []
32+
- New Section Request []
33+
- General Improvement []
34+
- Typo/Mistakes []
35+
- Other []
36+
37+
<!--
38+
Your help makes our Documentation better! We *deeply* appreciate your help in improving our Documentation.
39+
-->

‎.github/ISSUE_TEMPLATE/--feature-request.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "\U0001F9E8 Feature request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: new feature
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please fill out as much of the template as you can. Delete sections if unneccesary -->
11+
<!--
12+
Make Sure you've checked out Existing Issues
13+
-->
14+
15+
## Short Description
16+
<!-- Describe Your Idea -->
17+
18+
19+
## **How This Feature will help you/others**
20+
21+
22+
## **Possible Solution/Implementation Details**
23+
<!-- Describe the solution you'd like. -->
24+
25+
26+
## **Example/Links if Any**
27+
<!-- Link to already similar features across other OSS documentation -->
28+
29+
## **Can you help with this Feature**
30+
<!-- Pull Requests are much Appreciated -->
31+
32+
<!-- End. -->
33+
<!--
34+
Thank you! Your help makes our documentation better. We *deeply* appreciate it.
35+
-->

‎.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- This is the default Issue Template. Delete sections if unneccesary -->
2+
3+
## Short Description
4+
<!-- Description -->
5+
6+
## **Example/Links if Any**
7+
<!-- Links to Issue Location in aboutcode.readthedocs.io -->
8+
9+
<!-- Thank you for your help in improving our Documentation! -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Gitter Chat
4+
url: https://gitter.im/aboutcode-org/gsod-season-of-docs
5+
about: Please ask questions here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Delete Template sections if unneccesary -->
2+
<!-- Add issue number here (We encourage you to create the Issue First) -->
3+
<!-- You can also link the issue in Commit Messages -->
4+
5+
Fixes #0000
6+
7+
<!--
8+
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
9+
* [x] - Checked Box
10+
* [ ] - Unchecked Box
11+
-->
12+
13+
### Tasks
14+
15+
* [ ] PR is descriptively titled 📑 and links the original issue above 🔗
16+
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
17+
Run [tests](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html#continuous-integration) locally to check for errors.
18+
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
19+
20+
<!--
21+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
22+
if your tests fail at first!
23+
If tests do fail, click on the red `X` to learn why by reading the logs.
24+
Thanks!
25+
-->
26+
27+
<!-- Don't forget to Signoff -->

‎.github/config.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Configuration for welcome - https://github.com/behaviorbot/welcome
2+
3+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
4+
5+
# Comment to be posted to on first time issues
6+
newIssueWelcomeComment: |
7+
Thanks for opening your first issue! 👍🎉😄⚡️
8+
Do join our [Gitter channel](https://gitter.im/aboutcode-org/gsod-season-of-docs) for more discussions.
9+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
10+
11+
# Comment to be posted to on PRs from first time contributors in your repository
12+
newPRWelcomeComment: |
13+
Thanks for opening this pull request! 👍🎉😄⚡️
14+
Also please refer [Contributing related documentation](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html) for more help! 💿
15+
16+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
17+
18+
# Comment to be posted to on pull requests merged by a first time user
19+
firstPRMergeComment: |
20+
Congrats on merging your first pull request! 👍🎉😄⚡️
21+
Now that you've completed this, you can help on more [Issues](https://github.com/nexB/aboutcode/issues)
22+
23+
# It is recommend to include as many gifs and emojis as possible

‎docs/source/conf.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,10 @@
3939
'sphinx.ext.intersphinx'
4040
]
4141

42-
# Temporary Mapping, Once scancode-toolkit.readthedocs.io has the migrated docs, this can be changed to the same.
43-
intersphinx_mapping = {'scancode-toolkit': ('https://sphinx-test-ayan.readthedocs.io/en/scancode-toolkit/', None)}
42+
# This points to scancode-toolkit.readthedocs.io
43+
# In case of "undefined label" ERRORS check docs on intersphinx to troubleshoot
44+
# Link was created at commit - https://github.com/nexB/scancode-toolkit/commit/3a71e44a403e0da18217f327f2362f6031f53d4b
45+
intersphinx_mapping = {'scancode-toolkit': ('https://scancode-toolkit.readthedocs.io/en/latest/', None)}
4446

4547
# Add any paths that contain templates here, relative to this directory.
4648
templates_path = ['_templates']

‎docs/source/index.rst‎

Lines changed: 14 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
11
AboutCode Documentation
22
=======================
33

4-
Aboutcode Projects
5-
******************
4+
Aboutcode Documentation Websites
5+
--------------------------------
6+
7+
Scancode-Toolkit has it's documentation website at ``scancode-toolkit.readthedocs.io``.
8+
`Click here <scancode-toolkit.readthedocs.io>`_ to visit the Scancode Documentation.
9+
10+
Other Aboutcode Projects
11+
------------------------
12+
13+
These are the Projects which doesn't have a seperate documentation website currently.
14+
Note that these might be outdated, as these documentations are updated in their wiki's primarily.
615

716
.. toctree::
817
:maxdepth: 1
918

10-
scancode-toolkit/index
1119
scancode-workbench/index
1220
deltacode/index
1321
aboutcode-docs/home
1422
aboutcode-toolkit/index
1523
aboutcode-data/abcd
1624

1725
Documentation Guide
18-
*******************
26+
-------------------
1927

2028
.. toctree::
2129
:maxdepth: 2
@@ -24,56 +32,12 @@ Documentation Guide
2432
license
2533
doc_maintenance
2634

27-
28-
Getting Started
29-
***************
30-
31-
.. toctree::
32-
:maxdepth: 2
33-
34-
scancode-toolkit/getting-started/newcomer
35-
36-
Tutorial Documents
37-
******************
38-
39-
.. toctree::
40-
:maxdepth: 2
41-
42-
scancode-toolkit/tutorials/index
43-
44-
45-
How-To Documents
46-
****************
47-
48-
.. toctree::
49-
:maxdepth: 2
50-
51-
scancode-toolkit/how-to-guides/index
52-
53-
54-
Reference Documents
55-
*******************
56-
57-
.. toctree::
58-
:maxdepth: 2
59-
60-
scancode-toolkit/cli-reference/index
61-
62-
63-
Discussion Documents
64-
********************
65-
66-
.. toctree::
67-
:maxdepth: 2
68-
69-
scancode-toolkit/explanations/index
70-
7135
Indices and Tables
72-
******************
36+
------------------
7337

7438
* :ref:`genindex`
7539
* :ref:`modindex`
7640

7741
.. _improve_docs:
7842

79-
.. include:: /scancode-toolkit/rst_snippets/improve_docs.rst
43+
.. include:: /rst_snippets/improve_docs.rst

docs/source/scancode-toolkit/rst_snippets/improve_docs.rst renamed to docs/source/rst_snippets/improve_docs.rst

File renamed without changes.

0 commit comments

Comments
 (0)