Skip to content

Commit e10a9c6

Browse files
committed
Rename the "config_and_tools" folder to "contrib"
"contrib" is everything that is not core to the repository. As the configuration files and sphinx extensions are mostly specific to Open edX, it makes sense to move them to a specific "contrib" folder.
1 parent 75d4652 commit e10a9c6

File tree

11 files changed

+8
-8
lines changed

11 files changed

+8
-8
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Change Log
3535
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3636

3737
* Add ``featuretoggles`` Sphinx extension
38-
* Include ``config_and_tools`` folder in pip-installable package
38+
* Include ``contrib`` folder in pip-installable package
3939
* Add ADR 0001-config-and-tools.rst for adding a place in this repository for shared annotation configs and supporting tools.
4040

4141
[0.4.0] - 2020-07-22

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ annotating code which stores personally identifiable information (PII), these
1515
tools are optimized for that use case but can be generalized for other types of
1616
annotations.
1717

18-
Additionally, a logically separate part of this repository will contain specific annotation configurations and supporting tools, such as Sphinx extensions for documenting specific annotation types. See ``config_and_tools``.
18+
Additionally, a logically separate part of this repository will contain specific annotation configurations and supporting tools, such as Sphinx extensions for documenting specific annotation types. See the ``contrib`` folder.
1919

2020
Documentation
2121
-------------
File renamed without changes.

code_annotations/config_and_tools/config/feature_toggle_annotations.yaml renamed to code_annotations/contrib/config/feature_toggle_annotations.yaml

File renamed without changes.

code_annotations/config_and_tools/config/setting_annotations.yaml renamed to code_annotations/contrib/config/setting_annotations.yaml

File renamed without changes.

code_annotations/config_and_tools/sphinx/extensions/__init__.py renamed to code_annotations/contrib/sphinx/extensions/__init__.py

File renamed without changes.

code_annotations/config_and_tools/sphinx/extensions/base.py renamed to code_annotations/contrib/sphinx/extensions/base.py

File renamed without changes.

code_annotations/config_and_tools/sphinx/extensions/featuretoggles.py renamed to code_annotations/contrib/sphinx/extensions/featuretoggles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def find_feature_toggles(source_path):
2020
"""
2121
config_path = pkg_resources.resource_filename(
2222
"code_annotations",
23-
os.path.join("config_and_tools", "config", "feature_toggle_annotations.yaml"),
23+
os.path.join("contrib", "config", "feature_toggle_annotations.yaml"),
2424
)
2525
return find_annotations(source_path, config_path, ".. toggle_name:")
2626

code_annotations/config_and_tools/sphinx/extensions/settings.py renamed to code_annotations/contrib/sphinx/extensions/settings.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def find_settings(source_path):
2121
"""
2222
config_path = pkg_resources.resource_filename(
2323
"code_annotations",
24-
os.path.join("config_and_tools", "config", "setting_annotations.yaml"),
24+
os.path.join("contrib", "config", "setting_annotations.yaml"),
2525
)
2626
return find_annotations(source_path, config_path, ".. setting_name:")
2727

docs/decisions/0001-config-and-tools.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The new instances of annotation configs arose to support documenting Open edX fe
2121
Decision
2222
========
2323

24-
The code annotation tool is generic and specific annotation configs are logically separate. At the same time, it was decided that having a single place for annotation configs and there supporting tools would be efficient for our engineers, as well as potentially beneficial for sharing outside of Open edX. Additionally, we decided not to add the overhead of managing a separate repository at this time. Instead, we will add a ``config_and_tools`` directory in this repository to contain any shared annotation config files and supporting tools.
24+
The code annotation tool is generic and specific annotation configs are logically separate. At the same time, it was decided that having a single place for annotation configs and there supporting tools would be efficient for our engineers, as well as potentially beneficial for sharing outside of Open edX. Additionally, we decided not to add the overhead of managing a separate repository at this time. Instead, we will add a ``contrib`` directory in this repository to contain any shared annotation config files and supporting tools.
2525

2626
It is acknowledged that this need not be a permanent solution, but is a useful place to begin.
2727

@@ -30,4 +30,4 @@ Any affect on how the PII annotations are implemented, or where they are stored,
3030
Consequences
3131
============
3232

33-
We will move the new toggles annotations and its supporting tools to the new ``config_and_tools`` directory.
33+
We will move the new toggles annotations and its supporting tools to the new ``contrib`` directory.

0 commit comments

Comments
 (0)