Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/--doc-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: "Documentation Improvement"
about: Your suggestions for improving the Documentation.
title: ''
labels: 'documentation'
assignees: ''

---

<!--
Please fill out as much of the below template and delete unnecessary text.
Markdown Styling - https://commonmark.org/help/
-->

### Description

> A brief description of the Documentation Improvement or New Section request.


### Link to Documentation Page

> Where the confusion/inconsistency/incomplete documentation is.

<!--
Link to Specific Aboutcode Documentation Page from http://aboutcode.readthedocs.io/
-->

### Select Category
<!-- Which of this label correctly describe your Bug Report -->

- Inconsistency []
- New Section Request []
- General Improvement []
- Typo/Mistakes []
- Other []

<!--
Your help makes our Documentation better! We *deeply* appreciate your help in improving our Documentation.
-->
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/--feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "\U0001F9E8 Feature request"
about: Suggest an idea for this project
title: ''
labels: new feature
assignees: ''

---

<!-- Please fill out as much of the template as you can. Delete sections if unneccesary -->
<!--
Make Sure you've checked out Existing Issues
-->

## Short Description
<!-- Describe Your Idea -->


## **How This Feature will help you/others**


## **Possible Solution/Implementation Details**
<!-- Describe the solution you'd like. -->


## **Example/Links if Any**
<!-- Link to already similar features across other OSS documentation -->

## **Can you help with this Feature**
<!-- Pull Requests are much Appreciated -->

<!-- End. -->
<!--
Thank you! Your help makes our documentation better. We *deeply* appreciate it.
-->
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- This is the default Issue Template. Delete sections if unneccesary -->

## Short Description
<!-- Description -->

## **Example/Links if Any**
<!-- Links to Issue Location in aboutcode.readthedocs.io -->

<!-- Thank you for your help in improving our Documentation! -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Gitter Chat
url: https://gitter.im/aboutcode-org/gsod-season-of-docs
about: Please ask questions here.
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<!-- Delete Template sections if unneccesary -->
<!-- Add issue number here (We encourage you to create the Issue First) -->
<!-- You can also link the issue in Commit Messages -->

Fixes #0000

<!--
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
* [x] - Checked Box
* [ ] - Unchecked Box
-->

### Tasks

* [ ] PR is descriptively titled 📑 and links the original issue above 🔗
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
Run [tests](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html#continuous-integration) locally to check for errors.
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁

<!--
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
if your tests fail at first!
If tests do fail, click on the red `X` to learn why by reading the logs.
Thanks!
-->

<!-- Don't forget to Signoff -->
23 changes: 23 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Configuration for welcome - https://github.com/behaviorbot/welcome

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: |
Thanks for opening your first issue! 👍🎉😄⚡️
Do join our [Gitter channel](https://gitter.im/aboutcode-org/gsod-season-of-docs) for more discussions.
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: |
Thanks for opening this pull request! 👍🎉😄⚡️
Also please refer [Contributing related documentation](https://aboutcode.readthedocs.io/en/latest/doc_maintenance.html) for more help! 💿

# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: |
Congrats on merging your first pull request! 👍🎉😄⚡️
Now that you've completed this, you can help on more [Issues](https://github.com/nexB/aboutcode/issues)

# It is recommend to include as many gifs and emojis as possible
6 changes: 4 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@
'sphinx.ext.intersphinx'
]

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

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
64 changes: 14 additions & 50 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
AboutCode Documentation
=======================

Aboutcode Projects
******************
Aboutcode Documentation Websites
--------------------------------

Scancode-Toolkit has it's documentation website at ``scancode-toolkit.readthedocs.io``.
`Click here <scancode-toolkit.readthedocs.io>`_ to visit the Scancode Documentation.

Other Aboutcode Projects
------------------------

These are the Projects which doesn't have a seperate documentation website currently.
Note that these might be outdated, as these documentations are updated in their wiki's primarily.

.. toctree::
:maxdepth: 1

scancode-toolkit/index
scancode-workbench/index
deltacode/index
aboutcode-docs/home
aboutcode-toolkit/index
aboutcode-data/abcd

Documentation Guide
*******************
-------------------

.. toctree::
:maxdepth: 2
Expand All @@ -24,56 +32,12 @@ Documentation Guide
license
doc_maintenance


Getting Started
***************

.. toctree::
:maxdepth: 2

scancode-toolkit/getting-started/newcomer

Tutorial Documents
******************

.. toctree::
:maxdepth: 2

scancode-toolkit/tutorials/index


How-To Documents
****************

.. toctree::
:maxdepth: 2

scancode-toolkit/how-to-guides/index


Reference Documents
*******************

.. toctree::
:maxdepth: 2

scancode-toolkit/cli-reference/index


Discussion Documents
********************

.. toctree::
:maxdepth: 2

scancode-toolkit/explanations/index

Indices and Tables
******************
------------------

* :ref:`genindex`
* :ref:`modindex`

.. _improve_docs:

.. include:: /scancode-toolkit/rst_snippets/improve_docs.rst
.. include:: /rst_snippets/improve_docs.rst
Loading