Skip to content

Commit 4a57279

Browse files
Merge branch 'main' into DOCSS-1633-incorrect-example
2 parents 46b18db + a8b37be commit 4a57279

File tree

368 files changed

+61216
-1197
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

368 files changed

+61216
-1197
lines changed

.circleci/config.yml

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ version: 2.1
33
orbs:
44
aws-cli: circleci/[email protected]
55
vale: circleci/[email protected]
6-
go: circleci/[email protected].2
6+
go: circleci/[email protected].3
77

88
executors:
99
node_executor:
1010
docker:
11-
- image: cimg/node:22.18.0
11+
- image: cimg/node:22.19.0
1212
working_directory: ~/project
1313

1414
go_executor:
@@ -45,18 +45,6 @@ jobs:
4545
executor: node_executor
4646
steps:
4747
- checkout
48-
- run:
49-
name: Fetch branches matching server-4*
50-
command: |
51-
for branch in $(git ls-remote --heads origin | awk '{print $2}' | grep 'refs/heads/server-4' | sed 's|refs/heads/||'); do
52-
echo "[INFO] Fetching branch: $branch"
53-
git checkout "$branch"
54-
git pull origin "$branch"
55-
done
56-
git checkout "${CIRCLE_BRANCH}"
57-
- add_ssh_keys:
58-
fingerprints:
59-
- "SHA256:Plac654CPBty6yA26H7QMKCqM0yD1XWds7UwNqOYzJU"
6048
- run:
6149
name: Install Node Dependencies
6250
command: npm ci

.htmltest.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@ BaseURL: https://circleci.com/docs
66
IgnoreAltEmpty: true
77
IgnoreInternalEmptyHash: true
88
IgnoreURLs:
9-
- "[url]"
10-
- "[path]"
11-
- "/docs/"
12-
- "/docs/_/img/x-icon.svg"
9+
- "\\[url\\]" # Escaped literal [url] placeholder in search templates
10+
- "^/docs/" # All absolute paths from 404 page (navigation + assets)
1311
IgnoreDirs:
1412
- "api"
1513
OutputDir: ".htmltest"

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v22.18.0
1+
22.19.0

CONTENT_AUTHORING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The CircleCI documentation is organized into logical components, each focusing o
2121
| `root` | Home and landing pages | `docs/root/` |
2222
| `guides` | How-to guides and tutorials | `docs/guides/` |
2323
| `reference` | API and configuration references | `docs/reference/` |
24-
| `orbs` | CircleCI Orbs documentation | `docs/orbs/` |
25-
| `server-admin` | Server administration guides | `docs/server-admin/` |
24+
| `orbs` | CircleCI orbs documentation | `docs/orbs/` |
25+
| `server-admin` | Server administration guides | `docs/server-admin-4.*/` |
2626
| `contributors` | Contributor guidelines | `docs/contributors/` |
2727

2828
### File Organization
@@ -244,7 +244,7 @@ xref:page-name.adoc#section-id[Link Text]
244244
Link to external resources:
245245

246246
```asciidoc
247-
https://circleci.com[CircleCI Website]
247+
link:https://circleci.com[CircleCI Website]
248248
```
249249

250250
### Navigation Files

DEVELOPMENT.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -84,23 +84,11 @@ The site will be available at `http://localhost:3000` by default.
8484
npm run build:docs
8585
```
8686

87-
- **Fetch server branches** (for server admin docs). You will need to have local copies of all server-4* branches to be able to build the full docs site locally:
88-
```bash
89-
npm run fetch-server-branches
90-
```
91-
92-
- **Force fetch server branches** if you want to force all your server-4* branches to the state of the upstream "current" versions, use the --force flag. This is recommended if you have no local changes on any server-4* branch:
93-
94-
```bash
95-
npm run fetch-server-branches --force
96-
```
97-
9887

9988
### Branch Strategy
10089

10190
- `main` - Production-ready code
10291
- Feature branches - Named according to the feature being developed
103-
- Version branches - For version-specific documentation (e.g., `server-4.1`)
10492

10593
## Content Authoring
10694

@@ -248,17 +236,6 @@ The UI uses Tailwind CSS for styling:
248236

249237
## Advanced Development Tasks
250238

251-
## Updating server version branches
252-
253-
When changes are made to the main branch to the build processes, the UI, or all components OTHER than server-administration, all server branches should be rebased once the changes are merged. The process for this is as follows:
254-
255-
1. Update local main branch
256-
2. Checkout a server branch
257-
3. Run `git rebase main`
258-
4. Push those changes with `git push --force-with-lease origin server-4.1` - remember to use the correct server branch number.
259-
260-
This should be done for every server-4* branch.
261-
262239
### Creating a New Component
263240

264241
1. **Create component directory**:

antora-playbook.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,19 @@ content:
1515
- url: .
1616
start_path: docs/orbs
1717
- url: .
18-
start_path: docs/server-admin
19-
branches: [server-4*]
18+
start_path: docs/server-admin-4.8
19+
- url: .
20+
start_path: docs/server-admin-4.7
21+
- url: .
22+
start_path: docs/server-admin-4.6
23+
- url: .
24+
start_path: docs/server-admin-4.5
25+
- url: .
26+
start_path: docs/server-admin-4.4
27+
- url: .
28+
start_path: docs/server-admin-4.3
29+
- url: .
30+
start_path: docs/server-admin-4.2
2031
- url: .
2132
start_path: docs/contributors
2233
ui:
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)