docs icon indicating copy to clipboard operation
docs copied to clipboard

Add 'Platform' area to Buildkite Docs along with implementing other related changes

Open gilesgas opened this issue 1 year ago • 2 comments

Here's a summary of changes that relate to this PR:

  • Add a new Platform area to the Buildkite Docs (preview here), content will be added to this landing page once messaging is solidified. Into this area, the following sections have been moved:

    • CLI from Pipelines to Platform (preview here).
    • Team management from Pipelines to Platform (preview here).
      • Extracted Pipeline-specific content and created a new page for it in the form of Security > Permissions in Pipelines (preview here). This page is similar to the existing one we have for Packages and Test Analytics.
    • SSO from Integrations to Platform (preview here).
  • Move the remaining components of Integrations (which are all Pipeline-related) to Pipelines (preview here):

    • Plugins (preview here).
    • Other integrations (new nav category for existing page content)

gilesgas avatar Jul 10 '24 06:07 gilesgas

Preview URL: https://2881--bk-docs-preview.netlify.app

buildkite-docs-bot avatar Jul 10 '24 06:07 buildkite-docs-bot

A few items that need to be addressed:

  • Some of the User and team permissions page content (preview here) needs to be pulled back into the Pipelines docs in the form of a page that's similar to the User, team and registry permissions page of the Packages docs (called User, team and pipeline permissions). This is would be mainly the Pipeline-level permissions and Manage organization security for pipelines page sections, along with some other introductory contextual material. The content of all User, team and <Buildkite product> permissions pages should be modified slightly so that they no longer make reference to the User and team permissions page (now in Platform) being in the Pipeline docs area. ✅ checked OK with colleagues.

  • Reorganise the content so that their directories match the new docs structure. Ensure all relevant redirects have been implemented. ✅ checked OK with colleagues, but TBD.

gilesgas avatar Jul 10 '24 06:07 gilesgas

Superseded by another PR.

gilesgas avatar Sep 16 '24 04:09 gilesgas