Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

💬 Add section for team management topics #2483

Merged
merged 3 commits into from
Sep 20, 2023

Conversation

olyism
Copy link
Contributor

@olyism olyism commented Sep 19, 2023

Add navigation menu for product-agnostic team management pages, so we can group pages with similar purpose and support more team management feature Docs pages to come.

Summary of changes:

  • Add 'Team management' parent nav menu to the left navigation menu
    • Add simple Overview page for navigation and link to 'Manage API token' over under the APIs section
    • Move 2FA and User Permissions to this new parent nav menu, plus redirects
  • Add 'Manage API token' on the homepage reference section

Note: this is an interim solution to have a place for product-agnostic team management Docs pages, while we're still working on improving the overall navigation.

Screenshots:

Screenshot 2023-09-19 at 4 38 52 PM Screenshot 2023-09-19 at 4 31 34 PM

@buildkite-docs-bot
Copy link
Contributor

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

@olyism olyism force-pushed the doc-683-add-section-for-team-management-topics branch from 8899718 to 90dc326 Compare September 19, 2023 06:34
@github-actions github-actions bot added the pipelines Pull requests that update content related to Pipelines label Sep 19, 2023
@olyism olyism marked this pull request as ready for review September 19, 2023 06:39
@olyism olyism requested a review from a team September 19, 2023 06:39
@olyism olyism requested a review from jameshill September 19, 2023 06:39
@olyism
Copy link
Contributor Author

olyism commented Sep 19, 2023

hi @jameshill here's the Docs PR to create an interim nav menu for team management related features.

For future team management related features you can put the markdown file under pages/team_management and add the navigation under Team management in nav.yml.

Because Manage API token is under the APIs section, I've added this as a link in the Team Management Overview page.

config/routes.rb Outdated Show resolved Hide resolved
@github-actions github-actions bot added test-analytics Pull requests that update content related to Test Analytics api rest labels Sep 19, 2023
@olyism
Copy link
Contributor Author

olyism commented Sep 19, 2023

I reckon we could leave this 2FA tutorial out of the team-management, the benefit of leaving it under tutorials is that we can add the "enforce 2fa" documentation under team-management without it being confusing for readers having them side by side.

hi @jameshill I reverted 2FA back under the tutorials menu. However, we only have one page under the team-management menu. If released, it may give an impression that we have just one feature for team management.

Screenshot 2023-09-19 at 5 27 05 PM

That being said, if you're happy with the navigation structure then I can put this PR back into draft, and you can use the changes in this branch to add the new pages.

@olyism olyism force-pushed the doc-683-add-section-for-team-management-topics branch from 9e091c4 to ab3e904 Compare September 19, 2023 07:35
@olyism olyism marked this pull request as draft September 19, 2023 07:35
- Move permissions.md and assets under /team_management
- Created new team-management nav menu
- Added Team Management overview page
- Updated existing links
- Add redirect from existing url
@olyism olyism force-pushed the doc-683-add-section-for-team-management-topics branch from ab3e904 to ab80023 Compare September 19, 2023 07:45
@jameshill
Copy link
Contributor

jameshill commented Sep 19, 2023

hi @jameshill I reverted 2FA back under the tutorials menu. However, we only have one page under the team-management menu. If released, it may give an impression that we have just one feature for team management.
...
That being said, if you're happy with the navigation structure then I can put this PR back into draft, and you can use the changes in this branch to add the new pages.

Hey @olyism i've got two fast follow PRs to add additional features to that section.

  1. Enforce 2FA documentation #2485
  2. System Banners Documentation #2486

This was referenced Sep 19, 2023
@olyism
Copy link
Contributor Author

olyism commented Sep 19, 2023

Hey @olyism i've got two fast follow PRs to add additional features to that section.

Sounds good @jameshill 👍 let's quickly get this merged to unblock your follow up PRs.

@olyism olyism marked this pull request as ready for review September 19, 2023 23:34
Copy link
Contributor

@MelissaKaulfuss MelissaKaulfuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some slight tweaks to the words in Team Management.
Looks great!

pages/team_management.md Outdated Show resolved Hide resolved
pages/team_management.md Outdated Show resolved Hide resolved
Accept commit suggestion

Co-authored-by: Melissa Kaulfuss <[email protected]>
Accept commit suggestion

Co-authored-by: Melissa Kaulfuss <[email protected]>
@olyism
Copy link
Contributor Author

olyism commented Sep 19, 2023

Thanks @MelissaKaulfuss, great wording improvements, I've committed your suggestions 🙌

Copy link
Contributor

@MelissaKaulfuss MelissaKaulfuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good @olyism 👍🏻

@olyism olyism merged commit 81e1f21 into main Sep 20, 2023
@olyism olyism deleted the doc-683-add-section-for-team-management-topics branch September 20, 2023 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api pipelines Pull requests that update content related to Pipelines rest test-analytics Pull requests that update content related to Test Analytics
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants