Skip to content

Commit d9e79e2

Browse files
committed
Merge branch 'master' into gsoc24-swastkk
2 parents cfe1091 + c158429 commit d9e79e2

File tree

4 files changed

+23
-339
lines changed

4 files changed

+23
-339
lines changed

docs/source/contributing.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,19 @@
22
Contributing to AboutCode
33
#########################
44

5-
The AboutCode organization welcomes you and your interest in contributing to our
6-
organization. We are always looking for enthusiatic contributors and we are willing to
7-
lend a helping hand if you have any questions or comments. That being said, here a few
8-
resources to help you get started.
5+
We welcome you and your interest in contributing to open source software! AboutCode is always looking for enthusiatic contributors and we are happy to help with any questions or comments. Here a few resources to get started:
96

107
1) Take a look through our public repos here: https://github.com/aboutcode-org/
118
* Find one you are interested in and check out its open **Issues**
129
2) If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/
13-
* Depending on the project, there may be a seperate ReadTheDocs website
14-
* If you did not find what you were looking for or you still have questions,
15-
open an issue on the relevant repository, or ask directly via Gitter
10+
* Depending on the project, there may be a separate ReadTheDocs website
11+
* Not finding what you were looking for or still have questions? Open an issue on the relevant repository or ask directly via Gitter or Slack
1612

17-
You can always interact with the AboutCode organization and our extended community on Gitter_
13+
You can always interact with the AboutCode community on Gitter_ and Slack_.
1814

1915
.. _Gitter: https://gitter.im/aboutcode-org/discuss
16+
.. _Slack: https://join.slack.com/t/aboutcode-org/shared_invite/zt-2hjzc448i-SZULSuI0~h6YNSUnBWlAqA
17+
2018

2119
************************
2220
Contribution Guidelines:

docs/source/contributing/contrib_doc.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@
33
Contributing to the Documentation
44
=================================
55

6+
Document Software Setup
7+
-----------------------
8+
9+
AboutCode documentation is built using Sphinx.
10+
See http://www.sphinx-doc.org/en/master/index.html
11+
12+
AboutCode documentation is distributed using "Read the Docs".
13+
See https://readthedocs.org/
14+
15+
Individual document files are in reStructuredText format.
16+
See http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
17+
18+
You create, build, and preview AboutCode documentation on your local machine.
19+
20+
You commit your updates to the AboutCode repository on GitHub, which triggers
21+
an automatic rebuild of https://aboutcode.readthedocs.io/en/latest/index.html
22+
623
.. _contrib_doc_setup_local:
724

825
Setup Local Build

docs/source/doc_guidelines.rst

Lines changed: 0 additions & 330 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ Contributing and GSoC/GSoD
3535
contributing
3636
archive/gsoc-toc
3737
archive/gsod-toc
38-
doc_guidelines
3938

4039
******
4140
Others

0 commit comments

Comments
 (0)