Skip to content

Commit

Permalink
Merge pull request #2 from buildkite/add-platform-area-to-buildkite-docs
Browse files Browse the repository at this point in the history
Buildkite Docs Sept launch - Add 'Platform' area with other restructuring, rebrand TA > TE, rebrand Packages to Package Registries, and update landing pages
  • Loading branch information
gilesgas authored Oct 9, 2024
2 parents 4b154f7 + 08af663 commit dcdca34
Show file tree
Hide file tree
Showing 158 changed files with 1,424 additions and 969 deletions.
4 changes: 2 additions & 2 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ agent:
- pages/agent/**/*
cli:
- pages/cli/**/*
test-analytics:
- pages/test_analytics/**/*
test-engine:
- pages/test_engine/**/*
pipelines:
- pages/pipelines/**/*
- pages/tutorials/**/*
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ For example:
```
[
'pipelines/some-new-beta-feature',
'test-analytics/some-new-beta-feature',
'packages/some-new-beta-feature'
'test-engine/some-new-beta-feature',
'package-registries/some-new-beta-feature'
]
```

Expand Down
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ DEPENDENCIES
web-console

RUBY VERSION
ruby 3.3.3p89
ruby 3.3.5p100

BUNDLED WITH
2.4.7
2 changes: 1 addition & 1 deletion app/frontend/css/pages/homepage/_products.scss
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@

.ProductCard__img {
@media (min-width: $screen-xs) {
width: 148px;
height: 50px;
}
}
10 changes: 2 additions & 8 deletions app/models/beta_pages.rb
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
class BetaPages
def self.all
[
'pipelines/cluster-queue-metrics',
'test-analytics/test-ownership',
'apis/rest-api/team-pipelines',
'apis/rest-api/organizations/members',
'apis/rest-api/teams',
'apis/rest-api/teams/members',
'apis/rest-api/teams/pipelines',
'apis/rest-api/teams/suites'
'path/page-name',
'path/last-page-name-in-list-without-trailing-comma'
]
end
end
2 changes: 1 addition & 1 deletion app/views/homepage/_popular_guides.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
},
{
id: "glossary",
title: "Glossary",
title: "Pipelines glossary",
summary: "A list of common terms that describe key concepts",
link: "/docs/pipelines/glossary",
}
Expand Down
20 changes: 13 additions & 7 deletions app/views/homepage/_products.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,24 @@
<div class="Products__row">
<a href="/docs/pipelines" class="Products__link">
<article class="ProductCard">
<img alt="Pipelines graphic" class="ProductCard__img" src="<%= image_path('home/pipelines.svg') %>" />
<div>
<h2 class="ProductCard__title">Pipelines</h2>
<p class="ProductCard__summary">Powerful CI/CD built to scale on your infrastructure</p>
<img alt="Pipelines graphic" class="ProductCard__img" src="<%= image_path('home/pipelines.png') %>" />
<p class="ProductCard__summary">Powerful CI/CD built to scale on your choice of infrastructure</p>
</div>
</article>
<a href="/docs/test-analytics" class="Products__link">
<a href="/docs/test-engine" class="Products__link">
<article class="ProductCard">
<img alt="Test Analytics graphic" class="ProductCard__img" src="<%= image_path('home/test_analytics.svg') %>" />
<div>
<h2 class="ProductCard__title">Test Analytics</h2>
<p class="ProductCard__summary">Real-time tracking and monitoring for your tests</p>
<img alt="Test Engine graphic" class="ProductCard__img" src="<%= image_path('home/test_engine.png') %>" />
<p class="ProductCard__summary">Real-time, scalable tracking and monitoring for your tests</p>
</div>
</article>
</a>
<a href="/docs/package-registries" class="Products__link">
<article class="ProductCard">
<div>
<img alt="Packages graphic" class="ProductCard__img" src="<%= image_path('home/package_registries.png') %>" />
<p class="ProductCard__summary">Scale out asset management across any ecosystem</p>
</div>
</article>
</a>
Expand Down
49 changes: 29 additions & 20 deletions app/views/homepage/_references.html.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<%
references = [
{
title: "Pipeline",
title: "Pipelines",
links: [
{
title: "Step types",
Expand All @@ -23,28 +23,29 @@
]
},
{
title: "Agent",
title: "Test Engine",
links: [
{
title: "Configuration settings",
link: "/docs/agent/v3/configuration"
},
{
title: "Lifecycle hooks",
link: "/docs/agent/v3/hooks"
title: "JSON test results",
link: "/docs/test-engine/importing-json"
},
{
title: "CLI commands",
link: "/docs/agent/v3/cli-reference"
},
title: "Environment variables",
link: "/docs/test-engine/ci-environments"
}
]
},
{
title: "Packages",
links: [
{
title: "Elastic Stack template parameters",
link: "/docs/agent/v3/elastic-ci-aws/parameters"
title: "Package ecosystems",
link: "/docs/package-registries/ecosystems"
}
]
},
{
title: "API",
title: "APIs",
links: [
{
title: "REST API",
Expand All @@ -61,15 +62,23 @@
]
},
{
title: "Test Analytics",
title: "Agent",
links: [
{
title: "JSON test results",
link: "/docs/test-analytics/importing-json"
title: "Configuration settings",
link: "/docs/agent/v3/configuration"
},
{
title: "Environment variables",
link: "/docs/test-analytics/ci-environments"
title: "Lifecycle hooks",
link: "/docs/agent/v3/hooks"
},
{
title: "CLI commands",
link: "/docs/agent/v3/cli-reference"
},
{
title: "Elastic Stack template parameters",
link: "/docs/agent/v3/elastic-ci-aws/parameters"
}
]
}
Expand All @@ -78,7 +87,7 @@

<section class="References">
<div class="container container-narrow">
<h2 class="References__heading">APIs and references</h2>
<h2 class="References__heading">References and APIs</h2>
<nav>
<ul class="References__grid">
<% references.each do |item| %>
Expand Down
2 changes: 1 addition & 1 deletion app/views/landing_page_pipelines/_hero.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="Hero__content">
<article class="Article">
<h1>Buildkite Pipelines</h1>
<p>Create fast, secure, and reliable CI/CD with Buildkite Pipelines so you can quickly and confidently ship quality code. We provide the docs, building blocks, and extension points you'll need to build your dream CI/CD workflows. Let's get building! 🚀</p>
<p>Create fast, secure, and reliable CI/CD with <em>Buildkite Pipelines</em> so you can quickly and confidently ship quality code. Scale your builds with massive concurrency and flexible compute types, while fine-tuning each workflow to match your business needs. Let's get building! 🚀</p>
</article>
<div class="Hero__calls-to-action">
<a href="tutorials/getting-started" class="Button Button--purple">
Expand Down
18 changes: 12 additions & 6 deletions config/routes.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
get "/docs/api/organizations", to: redirect("/docs/apis/rest-api/organizations")
get "/docs/api/projects", to: redirect("/docs/apis/rest-api/pipelines")
get "/docs/api/*page", to: redirect("/docs/apis/rest-api/%{page}")
get "/docs/apis/graphql/cookbooks/packages", to: redirect("/docs/apis/graphql/cookbooks/registries")
get "/docs/apis/graphql-tutorial", to: redirect("/docs/apis/graphql/graphql-tutorial")
get "/docs/apis/graphql", to: redirect("/docs/apis/graphql-api")
get "/docs/apis/graphql/schemas", to: redirect("/docs/apis/graphql-api")
Expand Down Expand Up @@ -62,14 +63,17 @@
get "/docs/integrations/sso/g-suite", to: redirect("/docs/integrations/sso/google-workspace")
get "/docs/integrations/sso/cloud-identity", to: redirect("/docs/integrations/sso/g-cloud-identity")
get "/docs/integrations/sso/g-cloud-identity", to: redirect("/docs/integrations/sso/google-workspace-saml")
get "/docs/packages/manage-repositories", to: redirect("/docs/packages/manage-registries")
get "/docs/packages/nodejs", to: redirect("/docs/packages/javascript")
get "/docs/packages", to: redirect("/docs/package-registries")
get "/docs/packages/*page", to: redirect("/docs/package-registries/%{page}")
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/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")
get "/docs/pipelines/parallel-builds", to: redirect("/docs/tutorials/parallel-builds")
get "/docs/pipelines/permissions", to: redirect("/docs/team-management/permissions")
get "/docs/pipelines/permissions", to: redirect("/docs/pipelines/security/permissions")
get "/docs/pipelines/plugins", to: redirect("/docs/plugins")
get "/docs/pipelines/uploading-pipelines", to: redirect("/docs/pipelines/defining-steps")
get "/docs/pipelines/security-overview", to: redirect("/docs/pipelines/security/overview")
Expand All @@ -81,7 +85,9 @@
get "/docs/quickstart/*page", to: redirect("/docs/tutorials/%{page}")
get "/docs/rest-api", to: redirect("/docs/apis/rest-api")
get "/docs/rest-api/*page", to: redirect("/docs/apis/rest-api/%{page}")
get "/docs/test-analytics/js-collectors", to: redirect("/docs/test-analytics/javascript-collectors")
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/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 Expand Up @@ -133,7 +139,7 @@
get "/docs/agent/upgrading", to: redirect("/docs/agent/v3/upgrading", status: 301)
get "/docs/agent/upgrading-to-v3", to: redirect("/docs/agent/v3/upgrading", status: 301)
get "/docs/clusters/queue-metrics", to: redirect("/docs/pipelines/cluster-queue-metrics", status: 301)
get "/docs/test-analytics/java", to: redirect("/docs/test-analytics/importing-junit-xml", status: 301)
get "/docs/test-engine/java", to: redirect("/docs/test-engine/importing-junit-xml", status: 301)

# Old docs routes that we changed around during the development of the v3 agent docs
get "/docs/agent/upgrading-to-v2", to: redirect("/docs/agent/v2/upgrading-to-v2", status: 301)
Expand All @@ -143,7 +149,7 @@
get "/docs/agent/v3/agent-meta-data", to: redirect("/docs/agent/v3/cli-start#setting-tags", status: 301)

# Pre GA test analytics
get "/docs/test-analytics/integrations", to: redirect("/docs/test-analytics", status: 301)
get "/docs/test-analytics/integrations", to: redirect("/docs/test-engine", status: 301)

# Quick Reference JSON
get "/docs/quick-reference/pipelines", to: "quick_reference#pipelines", as: :pipelines_quick_reference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ fields:
type: UUIDv4 string
enumerated_values:
desc: |
A unique identifier for this test result. If a test execution with this UUID already exists in the Test Analytics database, this result is ignored.
A unique identifier for this test result. If a test execution with this UUID already exists in the Test Engine database, this result is ignored.
examples:
- 1b70486f-ca5f-4e6d-beb8-6347b2e49278
- name: scope
Expand Down
File renamed without changes.
Loading

0 comments on commit dcdca34

Please sign in to comment.