Skip to content

Commit

Permalink
Merge pull request #109 from buildkite/migrate-more-docs-from-pipelin…
Browse files Browse the repository at this point in the history
…es-to-platform

Move 2fa tutorial and emojis pages from Pipelines docs into new Platform area.
  • Loading branch information
gilesgas authored Nov 8, 2024
2 parents d43dcae + 0124ea4 commit 89cc50d
Show file tree
Hide file tree
Showing 16 changed files with 17 additions and 11 deletions.
4 changes: 3 additions & 1 deletion config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@
get "/docs/packages/manage-repositories", to: redirect("/docs/package-registries/manage-registries")
get "/docs/packages/nodejs", to: redirect("/docs/package-registries/javascript")
get "/docs/packages/permissions", to: redirect("/docs/package-registries/security/permissions")
get "/docs/pipelines/emoji", to: redirect("/docs/pipelines/emojis")
get "/docs/pipelines/emoji", to: redirect("/docs/platform/emojis")
get "/docs/pipelines/emojis", to: redirect("/docs/platform/emojis")
get "/docs/pipelines/images-in-log-output", to: redirect("/docs/pipelines/links-and-images-in-log-output")
get "/docs/pipelines/pipelines", to: redirect("/docs/pipelines")
get "/docs/pipelines/ignoring-a-commit", to: redirect("/docs/pipelines/skipping#ignore-a-commit")
Expand All @@ -94,6 +95,7 @@
get "/docs/test-analytics", to: redirect("/docs/test-engine")
get "/docs/test-analytics/*page", to: redirect("/docs/test-engine/%{page}")
get "/docs/test-analytics/js-collectors", to: redirect("/docs/test-engine/javascript-collectors")
get "/docs/tutorials/2fa", to: redirect("/docs/platform/tutorials/2fa")
get "/docs/tutorials/gitlab", to: redirect("/docs/integrations/gitlab")
get "/docs/tutorials/github-enterprise", to: redirect("/docs/integrations/github-enterprise")
get "/docs/tutorials/bitbucket", to: redirect("/docs/integrations/bitbucket")
Expand Down
10 changes: 6 additions & 4 deletions data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@
path: "tutorials/bazel"
- name: "Migrating to YAML steps"
path: "tutorials/pipeline-upgrade"
- name: "Two-factor authentication (2FA)"
path: "tutorials/2fa"
- name: "Using GitHub merge queues"
path: "tutorials/github-merge-queue"
- name: "Triggering Pipelines Using GitHub Actions"
Expand Down Expand Up @@ -286,8 +284,6 @@
path: "pipelines/notifications"
- name: "Job minutes"
path: "pipelines/job-minutes"
- name: "Emojis"
path: "pipelines/emojis"
- name: "Example pipelines"
path: "pipelines/example-pipelines"
- name: "Workflows"
Expand Down Expand Up @@ -570,8 +566,14 @@
path: "platform/team-management/enforce-2fa"
- name: "System banners"
path: "platform/team-management/system-banners"
- name: "Tutorials"
children:
- name: "Two-factor authentication (2FA)"
path: "platform/tutorials/2fa"
- name: "Audit log"
path: "platform/audit-log"
- name: "Emojis"
path: "platform/emojis"
- name: "CLI"
children:
- name: "Overview"
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion pages/pipelines/security/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Buildkite keeps up to date with software dependencies and has automated tools sc

## Code review and testing process

All pull requests are reviewed by senior engineers with security best practice training before being deployed to production systems. [Two-factor authentication (2FA)](/docs/tutorials/2fa) is enabled across GitHub and Buildkite organizations for added security.
All pull requests are reviewed by senior engineers with security best practice training before being deployed to production systems. [Two-factor authentication (2FA)](/docs/platform/tutorials/2fa) is enabled across GitHub and Buildkite organizations for added security.

An extensive set of automated testing procedures is run for every code change.

Expand Down
2 changes: 2 additions & 0 deletions pages/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The Buildkite platform documentation contains docs for _platform_-level features

- [Audit log](/docs/platform/audit-log), which provides details on how to access this feature within Buildkite, and all the events that are logged by this feature.

- [Emojis](/docs/platform/emojis), which can be used in your pipelines, test suites, and platform, to help you distinguish them.

- [Buildkite CLI](/docs/platform/cli), which provides command line/terminal access to work with features across the Buildkite platform.

- [Single sign-on (SSO)](/docs/platform/sso), with guidelines on how to protect access to your Buildkite organization using a supported third-party SSO provider.
Expand Down
2 changes: 1 addition & 1 deletion pages/pipelines/emojis.md → pages/platform/emojis.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Emojis

Buildkite supports over 300 custom emojis which you can use in your Pipelines and terminal output.
Buildkite supports over 300 custom emojis that you can use in your Buildkite [pipelines](/docs/pipelines/configuration-overview), including the terminal output of builds, as well as in [test suites](/docs/test-engine/test-suites) and [registries](/docs/package-registries/manage-registries).

To use an emoji, write the name of the emoji in between colons, like `\:buildkite\:` which shows up as :buildkite:.

Expand Down
2 changes: 1 addition & 1 deletion pages/platform/team_management/enforce_2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Please review the GraphQL [cookbook] for instructions on how to enable
enforced 2FA via the GraphQL API.

[cookbook]: </docs/apis/graphql/cookbooks/organizations#enforce-two-factor-authentication-2fa-for-your-organization>
[2FA tutorial]: </docs/tutorials/2fa>
[2FA tutorial]: </docs/platform/tutorials/2fa>
2 changes: 1 addition & 1 deletion pages/tutorials/2fa.md → pages/platform/tutorials/2fa.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
keywords: docs, pipelines, tutorials, 2fa
keywords: docs, pipelines, test suites, registries, tutorials, 2fa
---

# Two-factor authentication
Expand Down
4 changes: 2 additions & 2 deletions spec/models/page_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@

context "when page has keywords defined in frontmatter" do
it "returns the keywords" do
page = Page.new(view_double, "tutorials/2fa")
page = Page.new(view_double, "platform/tutorials/2fa")

expect(page.keywords).to eql("docs, pipelines, tutorials, 2fa")
expect(page.keywords).to eql("docs, pipelines, test suites, registries, tutorials, 2fa")
end
end

Expand Down

0 comments on commit 89cc50d

Please sign in to comment.