docs(huntsman): Add user-doc scaffolding. #441
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Configuration | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: | ||
|
|
||
| The guides below describe how to configure each of Spider's components. | ||
|
|
||
| ::::{grid} 1 1 2 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} | ||
| :link: storage | ||
| Storage configuration | ||
| ^^^ | ||
| How to configure Spider's storage backend. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} | ||
| :link: scheduler | ||
| Scheduler configuration | ||
| ^^^ | ||
| How to configure Spider's scheduler. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} | ||
| :link: worker | ||
| Worker configuration | ||
| ^^^ | ||
| How to configure Spider's workers. | ||
| ::: | ||
| :::: | ||
|
|
||
| :::{toctree} | ||
| :hidden: | ||
|
|
||
| storage.md | ||
| scheduler.md | ||
| worker.md | ||
| ::: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Scheduler configuration | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Storage configuration | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Worker configuration | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: |
|
Member
Author
There was a problem hiding this comment. @sitaowang1998 You should work on this section in a future PR. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Docker Compose deployment | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Deployment | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: | ||
|
|
||
| The guides below describe how to deploy a Spider cluster. | ||
|
|
||
| ::::{grid} 1 1 2 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} | ||
| :link: kubernetes | ||
| Kubernetes deployment | ||
| ^^^ | ||
| How to deploy Spider on Kubernetes. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} | ||
| :link: docker-compose | ||
| Docker Compose deployment | ||
| ^^^ | ||
| How to deploy Spider using Docker Compose. | ||
| ::: | ||
| :::: | ||
|
|
||
| :::{toctree} | ||
| :hidden: | ||
|
|
||
| kubernetes.md | ||
| docker-compose.md | ||
| ::: |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Kubernetes deployment | ||
|
|
||
| :::{warning} | ||
| 🚧 This section is still under construction. | ||
| ::: |
|
Member
Author
There was a problem hiding this comment. @20001020ycx You should work on this section in a future PR. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # User docs | ||
|
|
||
| This section contains docs for using and operating Spider. Choose one of the sections below or use | ||
| the left sidebar (if it's hidden, click the <i class="fa fa-bars"></i> icon) to navigate to specific | ||
| docs. | ||
|
|
||
| ::::{grid} 1 1 2 2 | ||
| :gutter: 2 | ||
|
|
||
| :::{grid-item-card} | ||
| :link: guides-deployment/index | ||
| Deployment | ||
| ^^^ | ||
| How to deploy a Spider cluster. | ||
| ::: | ||
|
|
||
| :::{grid-item-card} | ||
| :link: guides-configuration/index | ||
| Configuration | ||
| ^^^ | ||
| How to configure Spider's components. | ||
| ::: | ||
| :::: | ||
|
|
||
| :::{toctree} | ||
| :hidden: | ||
| :caption: Guides | ||
|
|
||
| guides-deployment/index.md | ||
| guides-configuration/index.md | ||
| ::: |
Oops, something went wrong.
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.
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.
I will be responsible for filling this section.