🚧 Add new documentation website with automated deployment #4422
Conversation
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Website/v0
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
another iteration on the Website
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Website/v0
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
feat(website): add preview command with GitHub Pages basePath support
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
UI: improve looks
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
| **High Throughput Processing** | ||
|
|
||
| - Handle millions of queued jobs simultaneously | ||
| - Specialized storage layer optimized for batch workloads |
There was a problem hiding this comment.
I am not sure about this part, it isn't intuitive to me what is Specialized storage layer
There was a problem hiding this comment.
Removed, is there anything special about the storage layer, or do we need to remove it from other sections as well ?
website/content/toc.mdx
Outdated
| **Client libraries and SDKs for different languages.** | ||
|
|
||
| - Python | ||
| - Java/Scala |
There was a problem hiding this comment.
Added, but I am unable to find the Go client under clients/, could you please provide a reference ? is it the same as the armadactl source code ?!
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Website/v0
|
|
||
| ## 2.2 Run More Jobs | ||
|
|
||
| ### Python Job Example |
There was a problem hiding this comment.
Here I added a very basic example, feel free to suggest something more suitable according to Armada usage
| ## 5.2 API Reference | ||
|
|
||
| - REST and gRPC APIs | ||
| - OpenAPI Spec (auto-generated) |
There was a problem hiding this comment.
Mention that it's designed to be used only with Lookout UI
| - Airflow Operator | ||
| - MetaFlow Integration | ||
| - Jenkins Integration | ||
| - Spark Integration |
|
|
||
| - Airflow Operator | ||
| - MetaFlow Integration | ||
| - Jenkins Integration |
There was a problem hiding this comment.
Not sure if useful for anyone
There was a problem hiding this comment.
Jenkins is still used in some places, but I don't know how it would link into armada.
|
|
||
| ## 5.1 CLI Reference | ||
|
|
||
| - Installing `armadactl` |
There was a problem hiding this comment.
based on https://github.com/spf13/cobra
There was a problem hiding this comment.
This orphans a large number of existing links; including:
- /design
- /quickstart
- /creating_and_submitting_jobs
- /client_libraries
- /contribute
This is not a complete list; but every top-level menu link from the old website is 404'ing in this new version. Orphaning links is annoying to users and hurts SEO performance. We should strive to ensure redirects exist for all existing links -- or at least the top level ones.
I am going to review this separately now for the content that exists.
|
|
||
| 1. **Single Cluster Scaling Limits**: Scaling a single Kubernetes cluster beyond a certain size is [challenging](https://openai.com/blog/scaling-kubernetes-to-7500-nodes/), typically maxing out around 5,000-15,000 nodes depending on configuration. | ||
|
|
||
| 2. **Storage Backend Constraints**: Achieving very high throughput using etcd, Kubernetes' in-cluster storage backend, is [challenging](https://etcd.io/docs/v3.5/op-guide/performance/) and can become a bottleneck for job queuing. |
There was a problem hiding this comment.
"challenging" used and highlighted in two sequential items. it looks a little strange rendered.
| ## Getting Started | ||
|
|
||
| > [!WARNING] | ||
| > TODO: add links |
There was a problem hiding this comment.
throughout: please resolve todos
|
|
||
| Ready to explore Armada? Here are your next steps: | ||
|
|
||
| 1. **Quick Start**: Try the local installation guide to get Armada running with Kind |
There was a problem hiding this comment.
The way this is worded, they imply they should be linked to something but are not.
|
|
||
| - Airflow Operator | ||
| - MetaFlow Integration | ||
| - Jenkins Integration |
There was a problem hiding this comment.
Jenkins is still used in some places, but I don't know how it would link into armada.
| <path d='M413.56,360.63l-47,44.74s19.17,37.64,47,50.88c27.79-13.24,47-50.88,47-50.88Z' /> | ||
| </g> | ||
| </g> | ||
| </svg> |
There was a problem hiding this comment.
This seems very wacky to me -- why aren't SVGs split out into their own files? While I know it's not what's happening; inlining images/filetypes is a common technique for obfuscation and my preference would be that we don't do it.
| # misc | ||
| .DS_Store | ||
| *.pem |
There was a problem hiding this comment.
Please could you move these to the root .gitignore if they aren't there already? This .gitignore should be specific to this directory only,
| # JetBrains IDEs | ||
| .idea/ | ||
|
|
||
| # Temporary files | ||
| tmp/ | ||
| *.tmp | ||
| tmp.* | ||
| *.tmp.* |
There was a problem hiding this comment.
These should also be moved to the root .gitignore if they aren't already there.
website/content/getting-started.mdx
Outdated
| #### 1. Create a queue | ||
|
|
||
| ```bash | ||
| armadactl create queue example |
There was a problem hiding this comment.
tiny nit - please could you rename example to example-queue to make it clear in subsequent commands that it refers to a queue?
| import markdown from '@eslint/markdown'; | ||
| import gitignore from 'eslint-config-flat-gitignore'; | ||
| import { defineConfig } from 'eslint/config'; | ||
|
|
There was a problem hiding this comment.
I have found it useful to add a spell checker to the linter in other projects, and am considering adding one to the Lookout UI too.
I think it would add value to this site given it's content-heavy, Please could you look into adding cspell or something like it?
website/package.json
Outdated
| "name": "armada-website", | ||
| "description": "Armada documentation website", | ||
| "version": "0.1.0", | ||
| "private": false, |
There was a problem hiding this comment.
| "private": false, | |
| "private": true, |
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Website/v0
4 participants
What type of PR is this?
Feature - New documentation website
What this PR does / why we need it:
This PR adds a modern documentation website for Armada using Next.js and Fumadocs. It replaces the current docs with a better user experience.
What's included:
Content status:
CI/CD features:
Preview: https://naskio.github.io/armada/
Which issue(s) this PR fixes:
Addresses need for improved documentation.
Special notes for your reviewer:
This is a work-in-progress PR to get early feedback on:
The remaining content will be added based on feedback. The goal is to establish a solid foundation before completing all sections.
Please test the preview site and let me know if you have concerns about the technical approach or content structure.