Skip to content

Commit 513fd83

Browse files
rosieyohannanquinnallmannotthepointSashaLsnko
authored
Rebase 4.7 (#228)
* Test deploy permissions (#197) * Test deploying to s3 bucket * Add aws cli for testing * Add contexts to test deploy job * Try syncing the build directory to the bucket * Move the deployment to the deploy-production job * disable the aws setup on the preview deploy * Api docs v2 formatting (#200) * claude's attempt to configure how api v2 looks * fix up some styling for the api v2 docs * logo link back to API docs * Add public-read permission to each file when syncing to s3 (#203) * Move the deploy directory to match the kong redirect and add public read permissions when syncing files (#205) * OKTA SSO group mappings docs (#178) * OKTA SSO group mappings docs * update screenshots plus some style and formatting fixes * couple of style fixes * fix lint errors in nav --------- Co-authored-by: Rosie Yohannan <[email protected]> * Remove preview prod deployment (#215) * Remove disabled deploy command * Add test menu link * Add a new file to test deployment as well * Add a file * Remove the acl param from the s3 upload (#216) * Clean up the deployment test files (#217) * remove dropdown from view outside hamburger menu (#222) * Add content for automatic reruns (#142) * add new page for automatic reruns * fixes from review * add basic entry to configuration reference * link to auto rerun docs from workflows page * Update docs/guides/modules/orchestrate/pages/automatic-reruns.adoc Co-authored-by: Sasha Lysenko <[email protected]> * Update docs/guides/modules/orchestrate/pages/automatic-reruns.adoc Co-authored-by: Sasha Lysenko <[email protected]> * add screenshot and clarify UI indicators * ui section again * minor edits * fix lint error * Update docs/guides/modules/orchestrate/pages/automatic-reruns.adoc * fixes from review * clarifications for limitations * remove line about scheduled workflows --------- Co-authored-by: Sasha Lysenko <[email protected]> * move API landing page into section to fix accordion (#224) * fix link to server docs (#226) * add server 4.7 * Update server 4.7 broken links (#202) * fix broken links * fix lint errors * fix some tab labels --------- Co-authored-by: Greg Roberts <[email protected]> Co-authored-by: Dorothy Jane Wingrove <[email protected]> Co-authored-by: Sasha Lysenko <[email protected]>
1 parent 5496dc3 commit 513fd83

File tree

17 files changed

+493
-35
lines changed

17 files changed

+493
-35
lines changed

.circleci/config.yml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,6 @@ jobs:
186186
deploy-production:
187187
executor: node_executor
188188
parameters:
189-
bucket_dir:
190-
default: "dorian"
191-
description: The directory in the bucket to deploy to.
192-
type: string
193189
bucket_name:
194190
description: The name of the s3 bucket where static assets are stored.
195191
type: string
@@ -205,12 +201,11 @@ jobs:
205201
name: Deploy Production Site to S3
206202
command: |
207203
AWS_S3_BUCKET=<< parameters.bucket_name >>
208-
BUCKET_DIRECTORY=<< parameters.bucket_dir >>
209204
BUILD_DIRECTORY=<< parameters.build_dir >>
210205
211206
set -e
212207
echo "[INFO] Deploying production site..."
213-
aws s3 cp "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/$BUCKET_DIRECTORY/" --recursive
208+
aws s3 sync "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/"
214209
- notify_error:
215210
message: "Production deployment job failed for branch ${CIRCLE_BRANCH}"
216211

@@ -276,15 +271,26 @@ workflows:
276271
filters:
277272
branches:
278273
ignore: main
279-
context: circleci-docs-static
274+
context:
275+
[
276+
circleci-docs-static,
277+
docs-platform-assets,
278+
web-ui-npm,
279+
web-ui-datadog,
280+
]
280281
- deploy-production:
281282
requires: [validate]
282283
filters:
283284
branches:
284285
only: main
285-
context: [circleci-docs-static, web-ui-org-settings, org-global]
286-
bucket_dir: "dorian"
287-
bucket_name: "circleci-docs-platform-assets/docs"
286+
context:
287+
[
288+
circleci-docs-static,
289+
docs-platform-assets,
290+
web-ui-npm,
291+
web-ui-datadog,
292+
]
293+
bucket_name: "circleci-docs-platform-assets/docs-preview"
288294
build_dir: "build"
289295
cleanup_preview:
290296
when: pipeline.parameters.cleanup_preview_branch != ""

custom-template.hbs

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<meta charset="utf8" />
6+
<title>{{title}}</title>
7+
<!-- needed for adaptive design -->
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<style>
10+
body {
11+
padding: 0;
12+
margin: 0;
13+
}
14+
15+
/* Custom logo styling - properly centered and clickable */
16+
.custom-logo {
17+
position: fixed;
18+
top: 15px;
19+
left: 15px;
20+
z-index: 1001;
21+
padding: 12px; /* Equal padding on all sides */
22+
display: flex;
23+
align-items: center;
24+
justify-content: center;
25+
width: fit-content;
26+
transition: all 0.2s ease;
27+
}
28+
29+
.custom-logo a:hover {
30+
transform: translateY(-1px);
31+
}
32+
33+
.custom-logo img {
34+
height: 32px;
35+
width: auto;
36+
display: block;
37+
}
38+
39+
/* Adjust sidebar to avoid logo overlap */
40+
.menu-content {
41+
padding-top: 70px !important;
42+
}
43+
44+
/* Hide logo on very small screens to avoid clutter */
45+
@media (max-width: 480px) {
46+
.custom-logo {
47+
display: none;
48+
}
49+
}
50+
51+
/* Adjust for medium screens */
52+
@media (max-width: 768px) {
53+
.custom-logo {
54+
position: relative;
55+
top: 0;
56+
left: 0;
57+
margin: 15px auto;
58+
display: block;
59+
text-align: center;
60+
max-width: none;
61+
width: fit-content;
62+
padding: 15px 20px;
63+
}
64+
65+
.menu-content {
66+
padding-top: 20px !important;
67+
}
68+
}
69+
</style>
70+
{{{redocHead}}}
71+
{{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
72+
</head>
73+
74+
<body>
75+
<!-- Clickable logo that routes to docs homepage -->
76+
<div class="custom-logo">
77+
<a href="../../reference/api-homepage.html" title="Back to CircleCI Documentation">
78+
<img src="logo.svg" alt="CircleCI" />
79+
</a>
80+
</div>
81+
82+
{{{redocHTML}}}
83+
</body>
84+
85+
</html>
82.2 KB
Loading
174 KB
Loading
191 KB
Loading

docs/guides/modules/ROOT/nav.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
*** xref:orchestrate:pipelines.adoc[Pipeline and triggers overview]
3939
*** xref:orchestrate:jobs-steps.adoc[Jobs and steps overview]
4040
*** xref:orchestrate:workflows.adoc[Workflow orchestration]
41+
*** xref:orchestrate:automatic-reruns.adoc[Automatic reruns]
4142
*** xref:orchestrate:workspaces.adoc[Use workspaces to share data between jobs]
4243
*** xref:orchestrate:dynamic-config.adoc[Use dynamic configuration]
4344
*** xref:orchestrate:skip-build.adoc[Skip CI and cancel workflows]
@@ -91,7 +92,7 @@
9192
** How-to guides
9293
*** xref:permissions-authentication:pull-an-image-from-aws-ecr-with-oidc.adoc[Pull an image from AWS ECR with OIDC]
9394
*** xref:execution-managed:run-a-job-in-a-container.adoc[Run a job in a container on your machine with Docker]
94-
*** xref:execution-managed:docker-compose.adoc[Installing and using docker-compose]
95+
*** xref:execution-managed:docker-compose.adoc[Installing and using Docker Compose]
9596
*** xref:execution-managed:high-uid-error.adoc[Debugging container ID cannot be mapped to host ID error]
9697
** Image support policies
9798
*** xref:execution-managed:android-images-support-policy.adoc[Android images support policy]
@@ -188,7 +189,7 @@
188189
*** xref:deploy:deploy-ios-applications.adoc[Deploy iOS applications]
189190
*** xref:deploy:deploy-over-ssh.adoc[Deploy over SSH]
190191
*** xref:deploy:publish-packages-to-packagecloud.adoc[Publish packages to Packagecloud]
191-
*** xref:deploy:deploy-to-npm-registry.adoc[Deploy to NPM registry]
192+
*** xref:deploy:deploy-to-npm-registry.adoc[Deploy to npm registry]
192193
193194
* Optimize
194195
** xref:optimize:optimizations.adoc[Optimizations reference]
@@ -225,6 +226,7 @@
225226
** SSO authentication
226227
*** xref:permissions-authentication:sso-overview.adoc[SSO overview]
227228
*** xref:permissions-authentication:set-up-sso.adoc[SSO setup]
229+
*** xref:permissions-authentication:sso-group-mapping.adoc[Set up SSO group mapping with Okta]
228230
*** xref:permissions-authentication:sign-in-to-an-sso-enabled-organization.adoc[Sign in to an SSO-enabled org]
229231
** Multi-factor authentication (MFA)
230232
*** xref:permissions-authentication:mfa.adoc[MFA overview]
@@ -288,7 +290,7 @@
288290
289291
* Developer toolkit
290292
** AI features
291-
*** xref:toolkit:using-the-circleci-mcp-server.adoc[Using the CircleCI MCP Server]
293+
*** xref:toolkit:using-the-circleci-mcp-server.adoc[Using the CircleCI MCP server]
292294
*** xref:toolkit:intelligent-summaries.adoc[Intelligent summaries]
293295
** CLI
294296
*** xref:toolkit:local-cli.adoc[Install and configure the CircleCI local CLI]
@@ -312,7 +314,7 @@
312314
* Plans and pricing
313315
** xref:plans-pricing:plan-overview.adoc[CircleCI plans overview]
314316
** xref:plans-pricing:credits.adoc[Credits overview]
315-
** xref:plans-pricing:plan-free.adoc[Free plan overview]
316-
** xref:plans-pricing:plan-performance.adoc[Performance plan overview]
317-
** xref:plans-pricing:plan-scale.adoc[Scale plan overview]
318-
** xref:plans-pricing:plan-server.adoc[Server plan overview]
317+
** xref:plans-pricing:plan-free.adoc[Free Plan overview]
318+
** xref:plans-pricing:plan-performance.adoc[Performance Plan overview]
319+
** xref:plans-pricing:plan-scale.adoc[Scale Plan overview]
320+
** xref:plans-pricing:plan-server.adoc[Server Plan overview]

docs/guides/modules/migrate/pages/migration-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Some things consider during this phase:
6060

6161
Ensure that your VCS org is linked to your CircleCI account and that your plan is applied. Log in using your VCS credentials as described on the xref:getting-started:first-steps.adoc[Sign Up and Try CircleCI] page.
6262

63-
If using the Server product, ensure that you have been provided with your trial license and that all prerequisites are met as described in the xref:server-admin:installation:index.adoc[server installation guides].
63+
If using the Server product, ensure that you have been provided with your trial license and that all prerequisites are met as described in the xref:server-admin:ROOT:index.adoc[server installation guides].
6464

6565
[#preparation-phase]
6666
== Preparation phase

0 commit comments

Comments
 (0)