You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,16 +35,16 @@ How To Contribute
35
35
36
36
Contributions are very welcome.
37
37
38
-
Please read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
38
+
Please read `How To Contribute <https://github.com/openedx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.
39
39
40
40
Even though they were written with ``edx-platform`` in mind, the guidelines
41
41
should be followed for Open edX code in general.
42
42
43
43
PR description template should be automatically applied if you are sending PR from github interface; otherwise you
44
-
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
44
+
can find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/openedx/code-annotations/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_
45
45
46
46
Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you
47
-
can find it at `ISSUE_TEMPLATE.md <https://github.com/edx/code-annotations/blob/master/.github/ISSUE_TEMPLATE.md>`_
47
+
can find it at `ISSUE_TEMPLATE.md <https://github.com/openedx/code-annotations/blob/master/.github/ISSUE_TEMPLATE.md>`_
48
48
49
49
Reporting Security Issues
50
50
-------------------------
@@ -64,8 +64,8 @@ refer to this `list of resources`_ if you need any assistance.
Copy file name to clipboardExpand all lines: docs/contrib/how_to/add_new_annotations_and_extracted_docs.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Annotations are a great way to keep documentation close to the code, but also be
13
13
14
14
As an example, we have added `feature toggle annotations to the edx-platform codebase`_. A `Readthedocs document with the edx-platform feature toggles`_ has been generated from them.
15
15
16
-
.. _feature toggle annotations to the edx-platform codebase: https://github.com/edx/edx-platform/search?q=toggle_name
16
+
.. _feature toggle annotations to the edx-platform codebase: https://github.com/openedx/edx-platform/search?q=toggle_name
17
17
.. _Readthedocs document with the edx-platform feature toggles: https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/featuretoggles.html
18
18
19
19
Add your own annotations and docs
@@ -27,7 +27,7 @@ The following steps need to be performed to document new types of annotations in
27
27
* Add a new documentation page in the `edx-platform technical docs that will use this Sphinx extension`_. Adapt this step as needed for other services.
28
28
* As required, add `custom linting for the new annotations to edx-lint`_. Again, follow the toggle and setting checkers as examples.
29
29
30
-
.. _new annotation format in code_annotations/contrib/config: https://github.com/edx/code-annotations/tree/master/code_annotations/contrib/config
31
-
.. _Sphinx extension to collect these annotations: https://github.com/edx/code-annotations/tree/master/code_annotations/contrib/sphinx/extensions
32
-
.. _edx-platform technical docs that will use this Sphinx extension: https://github.com/edx/edx-platform/tree/master/docs/technical
33
-
.. _custom linting for the new annotations to edx-lint: https://github.com/edx/edx-lint/blob/master/edx_lint/pylint/annotations_check.py
30
+
.. _new annotation format in code_annotations/contrib/config: https://github.com/openedx/code-annotations/tree/master/code_annotations/contrib/config
31
+
.. _Sphinx extension to collect these annotations: https://github.com/openedx/code-annotations/tree/master/code_annotations/contrib/sphinx/extensions
32
+
.. _edx-platform technical docs that will use this Sphinx extension: https://github.com/openedx/edx-platform/tree/master/docs/technical
33
+
.. _custom linting for the new annotations to edx-lint: https://github.com/openedx/edx-lint/blob/master/edx_lint/pylint/annotations_check.py
Copy file name to clipboardExpand all lines: docs/contrib/how_to/documenting_django_settings.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,4 +61,4 @@ There are a variety of tips in `certain sections of the how-to for documenting f
61
61
Additional resources
62
62
====================
63
63
64
-
The documentation format used to annotate non-boolean Django settings is also available from code-annotations repository: `setting_annotations.yaml <https://github.com/edx/code-annotations/blob/master/code_annotations/contrib/config/setting_annotations.yaml>`__.
64
+
The documentation format used to annotate non-boolean Django settings is also available from code-annotations repository: `setting_annotations.yaml <https://github.com/openedx/code-annotations/blob/master/code_annotations/contrib/config/setting_annotations.yaml>`__.
Copy file name to clipboardExpand all lines: docs/decisions/0001-config-and-tools.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,8 +15,8 @@ The original usage of this generic tool was for annotating PII in the Open edX p
15
15
16
16
The new instances of annotation configs arose to support documenting Open edX feature toggles and non-toggle settings. Each of these will also have Sphinx extensions to support documentation. To start, the `feature toggles annotation config`_ was added to the ``edx-toggles`` repository, but there was no good home for the non-toggle settings annotation config, nor the documentation tools.
0 commit comments