📖 Implement new website layout #2229
Conversation
kcp-ci-bot
added
needs-rebase
|
Going to figure out what I messed up (should have been a straightforward merge) and try again |
|
The merge conflict is from @clubanderson and I making the same change in parallel |
kcp-ci-bot
removed
the
needs-rebase
|
Please do not "Merge branch 'main' into doc-new-v2" |
|
I think that we only need one quickstart setup, making three new |
We can modify that file AFTER we get the new structure in place. |
kcp-ci-bot
added
the
needs-rebase
Squashing a whole bunch of minor website edits into one commit Squashing all the updates based on conversations in the PR into one basic redesign applied to current main minor tweaks to menu terminology cleaning up excess files fixed typo in mkdocs nav section more excess file cleanup Re-enabled nav links required by CNCF Sandbox deleting mis-copied files incorporating orphaned files into misc sections add missing misc-files.md and fix bad link in usage-basics.md Fix bad link in landing page fixing broken links in landing page fixing broken links in landing page modifications to home page layout and adding getting started menu tweaks to home.html more tweaks to home.html adjusting top menu in home.html adjusting top menu style in main_styles.html shortcut menu bar style in main-styles.html more shortcut menu bar style in main-styles.html still more shortcut menu bar style adjustment in main-styles.html fixed broken link on home page trying duplicate menu entries experimenting with md includes to build quickstart added missing file quickstart rewriting quickstart rewriting quickstart rewriting quickstart and pre-reqs slightly rewriting quickstart and pre-reqs slightly collapsed helm chart section into tabbed table changed and rearranged some labels import more of the workload commissioning process into the quickstart tweaking headings in pre-reqs.md pull in pre-reqs check script text renaming user-guide.md and relinking renaming user-guide.md and relinking change outdated message to say latest regular release fixed version number in get-started.md getting the helm chart md files synced to v0.23.0 updating common setup files to match release 0.23.0 missing environment variable in quick start fixing core chart navigation fix links and typos added reporting links to start of user guide typo fixes typo fixes
kcp-ci-bot
removed
the
needs-rebase
|
@MikeSpreitzer just helped me clean up the commits and merge conflicts in this PR |
|
LGTM label has been added. Git tree hash: 994c2ff960f6278ed6902d0cad5a5b1216f36287
|
| - Commission Workloads: direct/commission-workloads.md | ||
| - Installation & Usage Examples: | ||
| - Example Cluster Preparation: direct/hosting-cluster.md | ||
| - Sample scenarios: direct/examples.md |
There was a problem hiding this comment.
This file does not just have sample scenarios. It also has setup; in particular, it points to both the step-by-step and core-chart ways to setup.
I think that what we should have, in total, is:
- One quickstart setup that is concrete and uses
kind(no k3d, no OpenShift). - General setup instructions. These can include worked examples of particular steps, such as "for example, here is a way to create a k3d cluster with an Ingress controller with SSL passthrough enabled: ...".
- A collection of scenarios that can be run on any KubeStellar setup that has a hosting cluster and two WECs. These scenarios are parameterized by the names of three kubeconfig contexts, rather than insisting on
kind-kubeflex,cluster1, andcluster2. The scenarios doc starts with an explanation of its parameters. - The quickstart setup ends with a reference to the scenarios doc and fully literal commands to set the scenario parameter variables.
There was a problem hiding this comment.
The quickstart is actually built in significant part by use of multiple partial or complete includes from other markdown files, so it can render as a single page. It is by no means a finished thing.
There was a problem hiding this comment.
The inclusion relationships are based on an old organization, so I think that we are free to re-arrange as we see fit as we work out a better organization.
| - Step by Step: direct/common-setup-step-by-step.md | ||
| - Via Helm Chart: direct/common-setup-core-chart.md |
There was a problem hiding this comment.
These are still written as if they are part of the quickstart rather than being general instructions. Not sure which you intend.
There was a problem hiding this comment.
See my comment about building the quickstart by using includes. More editing of the associated files is definitely required.
|
The API reference link ( |
Oh! very good catch. Would it be more appropriate to link to the un-versioned reference at https://pkg.go.dev/github.com/kubestellar/kubestellar/api/control/v1alpha1 ? |
|
LGTM label has been added. Git tree hash: 56b348ef0eec4b62056b764ed2e84d993efc4923
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: clubanderson The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kcp-ci-bot
added
the
approved
| - Try the "Common-setup": direct/common-setup-intro.md | ||
| - Step by Step: direct/common-setup-step-by-step.md | ||
| - Via Helm Chart: direct/common-setup-core-chart.md | ||
| - Commission Workloads: direct/commission-workloads.md |
There was a problem hiding this comment.
I think this is about using KubeStellar after it is set up.
This replaces the existing kubestellar.io website with the new structure
This is a replacement for PR #2183. It incorporates many of the suggestions made there, as well as in other discussions
Preview at https://kproche.github.io/kubestellar/doc-new-v2
Related issue(s)
#2163, #2228, #2221, #2214, #2216, #2222
Fixes #