-
Notifications
You must be signed in to change notification settings - Fork 24
fix: documentation links and update references #551
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ This document will help you with the most important building blocks and provide | |
|
|
||
| ## Getting Started | ||
|
|
||
| 1. Create a new folder in `docs/_tooling/extensions` called `score_<name of your extension>` | ||
| 1. Create a new folder in `src/extensions` called `score_<name of your extension>` | ||
| 2. Copy the template inside the `__init__.py` | ||
| 3. Adapt to your needs | ||
|
|
||
|
|
@@ -76,7 +76,7 @@ extensions = [ | |
| ] | ||
| ``` | ||
|
|
||
| > **Important:** There cannot be any BUILD file inside the entire 'extensions' folder, as that would break the Python imports. | ||
| > **Important:** Each extension needs its own `BUILD` file to declare the `py_library` target and its dependencies. | ||
|
|
||
|
|
||
|
|
||
|
|
@@ -90,16 +90,13 @@ We perform testing with unit tests as well as integration tests that validate th | |
| ### Where to Place Your Test Code | ||
|
|
||
| ```bash | ||
| _tooling/ | ||
| ├── extensions/ | ||
| │ ├── README.md | ||
| │ ├── score_draw_uml_funcs/ | ||
| │ ├── YOUR_EXTENSION/ | ||
| │ │ ├── __init__.py # your python code (setup needs to be in here) | ||
| │ │ ├── xyz.py # your python code (if you need/want to split it across different files) | ||
| │ │ └── tests/ | ||
| │ │ ├── test_xyz.py # unit tests | ||
| │ │ └── test_YOUR_EXTENSION.py # integration tests | ||
| src/extensions/ | ||
| ├── YOUR_EXTENSION/ | ||
| │ ├── __init__.py # your python code (setup needs to be in here) | ||
| │ ├── xyz.py # your python code (if you need/want to split it across different files) | ||
| │ └── tests/ | ||
| │ ├── test_xyz.py # unit tests | ||
| │ └── test_YOUR_EXTENSION.py # integration tests | ||
|
Comment on lines
+94
to
+99
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The BUILD file that you described above is missing. |
||
| ├── score_metamodel/ | ||
| ├── score_plantuml.py | ||
| ``` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,8 +19,6 @@ | |
| Extensions | ||
| ========== | ||
|
|
||
| Hello there | ||
|
|
||
|
|
||
| .. grid:: 1 1 3 3 | ||
| :class-container: score-grid | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -371,14 +371,6 @@ score_source_code_linker/ | |
|
|
||
| --- | ||
|
|
||
| ## Clearing Cache Manually | ||
|
|
||
| To clear the build cache, run: | ||
|
|
||
| ```bash | ||
| rm -rf _build/ | ||
| ``` | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Guessing this is in prep for the other PR that auto deletes it?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Its repeated 10 lines above this block. Duplicate. |
||
| ## Examples | ||
|
|
||
| To see working examples for CodeLinks & TestLinks, take a look at the Docs-As-Code documentation. | ||
|
|
||
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
impossible to keep up here 😆