Repository navigation
Add Hugo Docsite - #1974
Add Hugo Docsite#1974
Conversation
|
The site looks great, great work! I would love to have a section for blogs and events if we could, highlighting upcoming events such as substrate day and kubecon NA. :) |
Let's consider that in a follow-up. Blogs will be a bit of a fun issue, because then we have to sort out policy about what sort of promotion upstream permits. That has been a bit of a pain point in Kubernetes. cc Tim Hockin (@thockin) I think we can put up a sort of banner for "official" events like substrate day, but it might be a bit late for that in the immediate future anyhow. |
|
We want sign-off from Brandon Royal (@brandonroyal) before shipping this. Thanks. |
3447ada to
5338326
Compare
|
one docs thing: #3105 |
Greg Castle (destijl)
left a comment
There was a problem hiding this comment.
This rocks, great job. The way I reviewed this was just looking at the front page. Is that right? I'm assuming the rest of the content is derived from the markdown documentation and if we want to fix it we should update the markdown source? Let me know if I'm off-base here.
In this new build, site/ literally contains no markdown. Everything is driven by the existing docs. So down the line we can just update the respective doc where they are and the site will hoover it all up. So yes, just the home page is owned by the site. |
9d4adfc to
8a7dd3b
Compare
695f0c1 to
50e17d5
Compare
|
Made a few suggestions offline, I like where the preview is heading, thank you!! Needs a rebase, we will revisit tomorrow. |
Add the Agent Substrate documentation website under site/ (https://ate.dev/), built with Hugo and the Docsy theme: - Reorganize user-facing docs under docs/{get-started,concepts,guides,reference,security,project}/ and move CONTRIBUTING.md, cmd/kubectl-ate/README.md, and benchmarking/README.md into docs/ with pointer files at their original paths. - Keep tutorial READMEs alongside their code in demos/*/README.md and mark contributor-only root docs with 'docsite: false' in YAML front matter. - Generate site/content/ on the fly via tools/site-content before serving or building the site, with zero checked-in Markdown stubs under site/content/. - Add homepage with zero-trust security principles, capability cards, interactive quickstart, and demo video, plus collapsible three-column doc layout, glossary hover cards, doc status banners, New release badges (tools/site-release-data), Copy as Markdown, and /llms.txt. Signed-off-by: Mofi Rahman <[email protected]>
50e17d5 to
57632fa
Compare
I will do a check. Should be pretty manageable. |
An SVG with CSS animation, which GitHub plays inline: 250 agents, the atenet router, 8 warm worker pods. Copy follows the docsite hero (agent-substrate#1974) and the greens come from the logo. The latency figure is left out until the number is settled. prefers-reduced-motion shows the static frame. Signed-off-by: Haven Xia <[email protected]>
An SVG with CSS animation, which GitHub plays inline: 250 agents, the atenet router, 8 warm worker pods. Copy follows the docsite hero (agent-substrate#1974) and the greens come from the logo. The latency figure is left out until the number is settled. prefers-reduced-motion shows the static frame. Signed-off-by: Haven Xia <[email protected]>
An SVG with CSS animation, which GitHub plays inline: 250 agents, the atenet router, 8 warm worker pods with several sandboxes each. Copy follows the docsite hero (agent-substrate#1974) and the greens come from the logo. The latency figure is left out until the number is settled. prefers-reduced-motion shows the static frame. Signed-off-by: Haven Xia <[email protected]>
An SVG with CSS animation, which GitHub plays inline: 250 agents, the atenet router, 8 warm worker pods with several sandboxes each. Copy follows the docsite hero (agent-substrate#1974) and the greens come from the logo. The latency figure is left out until the number is settled. prefers-reduced-motion shows the static frame. The badge row adds release, CI, govulncheck, stars and Trendshift. Go Report Card is retired, so it is left out. Signed-off-by: Haven Xia <[email protected]>
An SVG with CSS animation, which GitHub plays inline: 250 agents, the atenet router, 8 warm worker pods with several sandboxes each. Copy follows the docsite hero (agent-substrate#1974) and the greens come from the logo. The latency figure is left out until the number is settled. prefers-reduced-motion shows the static frame. The badge row adds release, CI, govulncheck, stars and Trendshift. Go Report Card is retired, so it is left out. Signed-off-by: Haven Xia <[email protected]>
Supersedes agent-substrate#3396 by @stshrive, rebased onto current `main`. The commit keeps his authorship and sign-off. The GKE provisioning and teardown tooling now lives in https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so core no longer carries a copy. Docs and comments that pointed at the removed files now point at substrate-gke. go mod tidy drops the GCP client modules only setup-gcp used, and vendor/ and _LICENSES/ are regenerated to match. Covers agent-substrate#3390, except that hack/teardown.sh is removed here as well; substrate-gke's tools/setup-gcp/teardown.sh replaces it. Part of agent-substrate#2304 ### Rebase notes Conflicts were mostly from the Hugo docsite move (agent-substrate#1974): - `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR. - `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the original edits, re-applied at the new paths. - `docs/guides/observability.md`: kept main's version, since agent-substrate#1974 already removed the Dashboards section the original PR edited. - `cmd/kubectl-ate/README.md`: kept main's stub that points to `docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp line, so the edit had nowhere to go. --------- Signed-off-by: Steven Shriver <[email protected]> Signed-off-by: Grant McCloskey <[email protected]> Co-authored-by: Steven Shriver <[email protected]>
Supersedes agent-substrate#3396 by @stshrive, rebased onto current `main`. The commit keeps his authorship and sign-off. The GKE provisioning and teardown tooling now lives in https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so core no longer carries a copy. Docs and comments that pointed at the removed files now point at substrate-gke. go mod tidy drops the GCP client modules only setup-gcp used, and vendor/ and _LICENSES/ are regenerated to match. Covers agent-substrate#3390, except that hack/teardown.sh is removed here as well; substrate-gke's tools/setup-gcp/teardown.sh replaces it. Part of agent-substrate#2304 ### Rebase notes Conflicts were mostly from the Hugo docsite move (agent-substrate#1974): - `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR. - `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the original edits, re-applied at the new paths. - `docs/guides/observability.md`: kept main's version, since agent-substrate#1974 already removed the Dashboards section the original PR edited. - `cmd/kubectl-ate/README.md`: kept main's stub that points to `docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp line, so the edit had nowhere to go. --------- Signed-off-by: Steven Shriver <[email protected]> Signed-off-by: Grant McCloskey <[email protected]> Co-authored-by: Steven Shriver <[email protected]> (cherry picked from commit b66e16a)
Supersedes #3396 by @stshrive, rebased onto current `main`. The commit keeps his authorship and sign-off. The GKE provisioning and teardown tooling now lives in https://github.com/ai-on-gke/substrate-gke under tools/setup-gcp, so core no longer carries a copy. Docs and comments that pointed at the removed files now point at substrate-gke. go mod tidy drops the GCP client modules only setup-gcp used, and vendor/ and _LICENSES/ are regenerated to match. Covers #3390, except that hack/teardown.sh is removed here as well; substrate-gke's tools/setup-gcp/teardown.sh replaces it. Part of #2304 ### Rebase notes Conflicts were mostly from the Hugo docsite move (#1974): - `tools/setup-gcp/cloud-sql.md`: deleted, as in the original PR. - `docs/guides/operator-install.md`, `docs/guides/postgres.md`: the original edits, re-applied at the new paths. - `docs/guides/observability.md`: kept main's version, since #1974 already removed the Dashboards section the original PR edited. - `cmd/kubectl-ate/README.md`: kept main's stub that points to `docs/reference/kubectl-ate.md`. That page no longer has the setup-gcp line, so the edit had nowhere to go. --------- Signed-off-by: Steven Shriver <[email protected]> Signed-off-by: Grant McCloskey <[email protected]> Co-authored-by: Steven Shriver <[email protected]> (cherry picked from commit b66e16a) Signed-off-by: Eitan Yarmush <[email protected]>
Fixes #1863
Github Pages URL from the fork: https://moficodes.github.io/substrate/