[WIP] - Arranger Dev Documentation #892
Draft
+401
−8,444
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justincorrigible
force-pushed
the
develop
branch
3 times, most recently
from
6b33e90
to
7f882d1
Compare
docs/05-Arranger.md
Outdated
| └── scripts/ | ||
| ``` | ||
|
|
||
| - **`docker/`**: Contains Docker configurations for various components. |
There was a problem hiding this comment.
Suggested change
| - **`docker/`**: Contains Docker configurations for various components. | |
| - **`docker/`**: Contains miscellaneous configuration files used for building Docker images of Arranger Server, and to support running a local developer environment. |
docs/05-Arranger.md
Outdated
| - **`docker/`**: Contains Docker configurations for various components. | ||
| - **`integration-tests/`**: Houses integration tests for system-wide functionality. | ||
| - **`modules`/**: Core Arranger modules: | ||
| - **`admin-ui/`**: Administration interface for managing Arranger configurations. |
There was a problem hiding this comment.
Suggested change
| - **`admin-ui/`**: Administration interface for managing Arranger configurations. | |
| - **`admin-ui/`**: (Inactive) Administration interface for generating and managing Arranger configuration files. |
docs/05-Arranger.md
Outdated
| - **`modules`/**: Core Arranger modules: | ||
| - **`admin-ui/`**: Administration interface for managing Arranger configurations. | ||
| - **`components/`**: React components for building search UIs. | ||
| - **`server/`**: Arranger Server implementation (GraphQL API). |
There was a problem hiding this comment.
Suggested change
| - **`server/`**: Arranger Server implementation (GraphQL API). | |
| - **`server/`**: the "Arranger" server itself, a GraphQL service that facilitates usage of Lucene-based search engines (e.g. Elasticsearch). |
docs/05-Arranger.md
Outdated
| - **`integration-tests/`**: Houses integration tests for system-wide functionality. | ||
| - **`modules`/**: Core Arranger modules: | ||
| - **`admin-ui/`**: Administration interface for managing Arranger configurations. | ||
| - **`components/`**: React components for building search UIs. |
There was a problem hiding this comment.
Suggested change
| - **`components/`**: React components for building search UIs. | |
| - **`components/`**: React components to streamline integration of search portals with an Arranger server. |
docs/05-Arranger.md
Outdated
| ``` | ||
|
|
||
| - **`docker/`**: Contains Docker configurations for various components. | ||
| - **`integration-tests/`**: Houses integration tests for system-wide functionality. |
There was a problem hiding this comment.
Suggested change
| - **`integration-tests/`**: Houses integration tests for system-wide functionality. | |
| - **`docs/`**: Markdown files that contain instructions on how to use Arranger and its capabilities, contribution guidelines, etc. | |
| - **`integration-tests/`**: Houses integration tests for system-wide functionality. |
docs/05-Arranger.md
Outdated
| │ ├── server/ | ||
| │ ├── test/ | ||
| │ └── ui/ | ||
| ├── integration-tests/ |
There was a problem hiding this comment.
Suggested change
| ├── integration-tests/ | |
| ├── docs/ | |
| ├── integration-tests/ |
MitchellShiell
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated developer documentation for Arranger
Description
To Do
With these items are completed I will finish the initial docs and follow-up for a more thorough review
Running the site locally (If you choose so)
Documented on the documentation site (so meta) here