Skip to content

Commit 4da5f9e

Browse files
committed
Merge branch 'master' into docs-rel-4-8-0
2 parents 2d873a8 + c350449 commit 4da5f9e

28 files changed

+540
-432
lines changed

.github/workflows/pull_request.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,6 @@ jobs:
109109

110110
- run: npm ci
111111

112-
- name: Versions on Release Branch Only
113-
if: ${{ startsWith(github.head_ref, 'docs-rel-') }}
114-
run: |
115-
make versions
116-
117112
- name: Build
118113
run: |
119114
touch .env

.github/workflows/release.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ jobs:
7272
run: |
7373
echo "CURRENT_STEP=Build" >> $GITHUB_ENV
7474
touch .env
75-
make versions-ci
7675
make build-ci
7776
7877
- name: Build with cached packs
@@ -139,7 +138,6 @@ jobs:
139138
run: |
140139
echo "CURRENT_STEP=Build" >> $GITHUB_ENV
141140
touch .env
142-
make versions-ci
143141
make build-ci
144142
145143
- name: Build with cached packs

Makefile

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ deep-clean: ## Clean all artifacts
5555
clean-logos: ## Clean logos
5656
rm -rf static/img/packs
5757

58-
clean-versions: ## Clean Docusarus content versions
58+
## Bundled versioning has been removed, but keeping the clean steps for now to allow people to clean up local artifacts.
59+
clean-versions: ## Clean Docusaurus content versions
5960
@echo "cleaning versions"
6061
rm -rf api_versions.json versions.json versioned_docs versioned_sidebars api_versioned_sidebars api_versioned_docs versioned_partials
6162
git checkout -- docusaurus.config.js static/robots.txt
@@ -183,17 +184,6 @@ build-ci: ## Run npm build in CI environment
183184
exit 1; \
184185
fi; \
185186
}
186-
187-
188-
versions: ## Create Docusarus content versions
189-
@echo "creating versions"
190-
./scripts/versions.sh $(TMPDIR)
191-
192-
193-
versions-ci: ## Create Docusarus content versions in a GitHub Actions CI environment
194-
@echo "creating versions"
195-
./scripts/versions.sh $$RUNNER_TEMP
196-
197187

198188
api: ## Generate API docs
199189
@echo "generating api docs"

README.md

Lines changed: 1 addition & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -606,8 +606,7 @@ component will automatically display the badge in the correct color based on the
606606
607607
This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
608608
scheme. The rows of cards are dynamically created according to the list of specified cards. This component uses the
609-
`VersionedLink` under the covers. URLs should be specified as discussed in the [Internal Links](#internal-links)
610-
section.
609+
`VersionedLink` under the covers.
611610
612611
```js
613612
<SimpleCardGrid
@@ -754,25 +753,6 @@ The snippet above will work with the example partial we have in our repository,
754753
Note that the `message` field corresponds to the `{props.message}` reference in the `_partials/_partial_example.mdx`
755754
file.
756755
757-
### Internal Links
758-
759-
Due to the complexities of Docusaurus plugin rendering, links do not support versioning in `*.mdx` files. If you want to
760-
add an internal link you will have to use the `VersionedLink` component inside the `*.mdx` file.
761-
762-
```mdx
763-
---
764-
partial_category: public-cloud
765-
partial_name: palette-setup
766-
---
767-
768-
This is how you set up Palette in {props.cloud}.
769-
770-
This is an <VersionedLink text="Internal Link" url="/getting-started/additional-capabilities"/>.
771-
```
772-
773-
The path of the link should be the path of the destination file from the root directory, without any back operators
774-
`..`. External links can be referenced as usual.
775-
776756
## Palette/VerteX URLs
777757
778758
A special component has been created to handle the generation of URLs for Palette and VerteX. The component is called
@@ -1000,30 +980,9 @@ The packs component will always display the top-level tab content, so if you add
1000980
new `TabItem` component is the first in the list. If a new pack version does not have a respective tag, the latest
1001981
version content will be displayed automatically.
1002982

1003-
#### Links
1004-
1005-
When authoring additional details content, you must use the `<VersionedLink />` component to link to other documentation
1006-
pages. The component is required to ensure that the links are versioned correctly. Refer to the
1007-
[Internal Links](#internal-links) section for more information.
1008-
1009-
If you want to link to a heading inside the pack component, you must also use the `<VersionedLink />` and include the
1010-
path to the component followed by the heading id. The following is an example of how to link to a heading inside the
1011-
pack component. Take note of the `#` symbol followed by the heading id.
1012-
1013-
```mdx
1014-
<VersionedLink
1015-
text="Change Cluster DNS Service Domain"
1016-
url="/integrations/packs/?pack=kubernetes-eks#change-cluster-dns-service-domain"
1017-
/>
1018-
```
1019-
1020-
Omit the `version=xxxx&parent=xxxx` value that is part of the query string. If you include the `version` and `parent`
1021-
values, the link will not work as expected.
1022-
1023983
### Link to a Pack
1024984

1025985
You must use the `<VersionedLink />` component to link to a pack. The following is an example of how to link to a pack.
1026-
For more information, refer to the [Internal Links](#internal-links) section.
1027986

1028987
```mdx
1029988
<VersionedLink text="Change Cluster DNS Service Domain" url="/integrations/packs/?pack=kubernetes-eks" />
@@ -1258,61 +1217,6 @@ new release tag is created.
12581217
> Do not use `feat`,`perf`, `fix`, or other semantic-release key words that trigger a version change. Use the commit
12591218
> message prefix `docs: yourMessageHere` for regular documentation commits.
12601219

1261-
## Versioning
1262-
1263-
> [!NOTE]
1264-
>
1265-
> Detailed documentation for versioning can be found in the internal
1266-
> [Versioning](https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1962639377/Versioning) guide.
1267-
1268-
All versioned content belongs to a specific version branch. The version branch name follows the naming convention
1269-
`version-X-X`. The version branch is used to generate versioned content.
1270-
1271-
There are three files that are used for generating versioned content:
1272-
1273-
- [`versions.sh`](./scripts/versions.sh) - A bash script that loops through all the version branches and generates the
1274-
versionioned content.
1275-
1276-
- [`update_docusaurs_config.js`](./docsearch.config.json) - A node script that updates the `docusaurus.config.js` file
1277-
with all the required vesioning parameters.
1278-
1279-
- [`versionsOverride.json`](./versionsOverride.json) - A JSON file that contains the versioning overrides. These values
1280-
are used to update the `docusaurus.config.js` file with non-default values.
1281-
1282-
### Build Versioned Content Locally
1283-
1284-
To build versioned content locally, use the following steps:
1285-
1286-
1. Issue the following command to generate the versioned content.
1287-
1288-
```shell
1289-
make versions
1290-
```
1291-
1292-
2. Start a local development server to view the versioned content.
1293-
1294-
```shell
1295-
make start
1296-
```
1297-
1298-
3. Compile the versioned content to ensure a successful build.
1299-
1300-
```shell
1301-
make build
1302-
```
1303-
1304-
4. Remove the `versions.json` file and discard the changes to the `docusaurus.config.js` file. Use the following command
1305-
to remove all version artifacts.
1306-
1307-
```shell
1308-
make clean-versions
1309-
```
1310-
1311-
> [!WARNING]
1312-
>
1313-
> The `docusaurus.config.js` file is updated by the [`update_docusaurus_config.js`](./docusaurus.config.js) script. DO
1314-
> NOT commit this file with the updated changes.
1315-
13161220
## Exit Codes
13171221

13181222
Librarium provides the following exit codes. These exit codes are returned by both the `npm run start` and

_partials/self-hosted/management-appliance/_installation-steps-prereqs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ partial_name: installation-steps-prereqs
2222

2323
- Two disks per node.
2424

25-
- The first disk must be at least 250 GB and is used for the {props.version} ISO stack. You specify the device in the `stylus_config.yaml` file during the initial Install {props.version} steps.
25+
- The first disk must be 300 GB minimum and 500 GB is recommended. This disk is used for the {props.version} ISO stack. You specify the device in the `stylus_config.yaml` file as guided during the **Install {props.version}** steps.
2626

2727
If the device is not specified, the default value is `auto`. This means the installer selects the largest available drive, which may not be the desired behavior, especially in multi-drive environments.
2828

archiveVersions.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
2+
"v4.7.x": "https://version-4-7.legacy.docs.spectrocloud.com",
3+
"v4.6.x": "https://version-4-6.legacy.docs.spectrocloud.com",
24
"v4.5.x": "https://version-4-5.legacy.docs.spectrocloud.com",
35
"v4.4.x": "https://version-4-4.legacy.docs.spectrocloud.com",
46
"v4.3.x": "https://version-4-3.legacy.docs.spectrocloud.com",

docs/docs-content/clusters/public-cloud/aws/eks-hybrid-nodes/prepare-environment/prepare-edge-hosts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ required Edge artifacts.
831831
15. Provision your edge hosts using the installer ISO created in the `build` directory. You can use the following
832832
sections to help you:
833833
834-
- [Provision Virtual Machines](/tutorials/clusters/edge/deploy-cluster/#provision-virtual-machines)
834+
- [Provision Virtual Machines](/tutorials/clusters/edge/deploy-cluster/#provision-edge-virtual-machines)
835835
- [Installation on Bare Metal](../../../../edge/site-deployment/stage.md)
836836
837837
Ensure your edge hosts are fully provisioned, configured, and active before performing [validation](#validate-1).

0 commit comments

Comments
 (0)