Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ This page provides information about how to create and maintain an installation

- You're a user of a DiracX installation looking for how to submit jobs, access data or similar. See the [User Guide](../user/index.md).
- You're instead looking to develop software which uses DiracX programmatically, e.g. to submit jobs.
Instead check out the user documentation on [programmatic access](../user/reference/programmatic-usage/index.md).
Instead check out the user documentation on [programmatic access](../user/how-to/programmatic-usage/index.md).
- You already know how to manage DiracX and are looking for specific information, see the sidebar on the left for more specific or in-depth documentation.
2 changes: 1 addition & 1 deletion docs/dev/explanations/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is typically done by larger installations that serve a single virtual organ
## Do you need an extension?

Before going any further you should consider if you even need a DiracX extension.
Creating a standard python package which uses the [DiracX Python API](../../user/reference/programmatic-usage/python-interface.md) might be a better choice as this will be more stable over time and leave you with more flexibility in how you implement your code.
Creating a standard python package which uses the [DiracX Python API](../../user/how-to/programmatic-usage/python-interface.md) might be a better choice as this will be more stable over time and leave you with more flexibility in how you implement your code.
For example, if you wish to create a job submission framework that lets people submit specialized jobs, monitor their status and then download data you're likely best off not making a DiracX extension.

Alternatively, you should make an extension if you want for example to:
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This page will not help you if:

- You're a user of a DiracX installation looking for how to submit jobs, access data or similar. See the [User Guide](../user/index.md).
- You're instead looking to develop software which uses DiracX programmatically, e.g. to submit jobs.
Instead check out the user documentation on [programmatic access](../user/reference/programmatic-usage/index.md).
Instead check out the user documentation on [programmatic access](../user/how-to/programmatic-usage/index.md).
- You're an installation admin looking to install, manage or debug your DiracX installation. See the [Administrator Guide](../admin/index.md).
- You're only interested in developing `diracx-web`, see the [dedicated tutorial](...).
- You already know how to develop DiracX and are looking for specific information, see the sidebar on the left for more specific or in-depth documentation.
6 changes: 6 additions & 0 deletions docs/user/how-to/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# How-To

Task-oriented guides for interacting with DiracX as a user.

- [**Command Line & Programmatic Usage**](programmatic-usage/index.md) — Interact with DiracX from the command line, from Python, or directly over HTTPS.
- [**Web Interface**](web-interface/index.md) — Use DiracX Web to monitor jobs and manage application instances through your browser.
2 changes: 1 addition & 1 deletion docs/user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ Welcome to the DiracX user guide. This page gives an overview of how use DIRAC t
If instead:

- You are an installation admin looking to install, manage or debug your DiracX installation. See the [Administrator Guide](../admin/index.md).
- You are looking to develop software which uses DiracX programmatically, e.g. to submit jobs, check out the user documentation on [programmatic access](../user/reference/programmatic-usage/index.md).
- You are looking to develop software which uses DiracX programmatically, e.g. to submit jobs, check out the user documentation on [programmatic access](../user/how-to/programmatic-usage/index.md).
- You want to learn how to develop for DiracX, check the [Developer Guide](../dev/index.md)
- You already know how to manage DiracX and are looking for specific information, see the sidebar on the left for more specific or in-depth documentation.
17 changes: 9 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,17 @@ nav:
- Tutorials:
- user/tutorials/index.md
- How-To:
- Command Line: user/reference/programmatic-usage/command-line-interface.md
- user/how-to/index.md
- Command Line: user/how-to/programmatic-usage/command-line-interface.md
- Programmatic Usage:
- user/reference/programmatic-usage/index.md
- Python: user/reference/programmatic-usage/python-interface.md
- HTTPS: user/reference/programmatic-usage/https-interface.md
- user/how-to/programmatic-usage/index.md
- Python: user/how-to/programmatic-usage/python-interface.md
- HTTPS: user/how-to/programmatic-usage/https-interface.md
- Web Interface:
- user/how-to/index.md
- Logging in: user/how-to/login-out.md
- List and share applications: user/how-to/list-and-share-applications.md
- Monitor jobs: user/how-to/monitor-jobs.md
- user/how-to/web-interface/index.md
- Logging in: user/how-to/web-interface/login-out.md
- List and share applications: user/how-to/web-interface/list-and-share-applications.md
- Monitor jobs: user/how-to/web-interface/monitor-jobs.md
- Explanations:
- user/explanations/index.md
- Reference:
Expand Down