Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add guides section #11199

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

Merged
merged 7 commits into from
Dec 15, 2023
Merged

docs: add guides section #11199

merged 7 commits into from
Dec 15, 2023

Conversation

stirby
Copy link
Collaborator

@stirby stirby commented Dec 14, 2023

Overview

This adds a "guides" section to our docs for employee-written tutorials. Also referred to internally as the Knowledge Base.

Includes @Emyrk's guide on Okta and an example guide for contributing.

Showcase

Guides as they appear on the website:
Screenshot 2023-12-13 at 9 20 04 PM

As they appear in Github:
Screenshot 2023-12-13 at 9 22 07 PM

The index page (could be improved):

Screenshot 2023-12-13 at 9 20 34 PM

Copy link
Member

@Emyrk Emyrk left a comment

Choose a reason for hiding this comment

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

Sweet! I wonder if there is a way to improve that search bar up top. I often do a search, and end up in the auto generated flag/env var section of the docs, where I want the "guide".

@stirby
Copy link
Collaborator Author

stirby commented Dec 14, 2023

Sweet! I wonder if there is a way to improve that search bar up top. I often do a search, and end up in the auto generated flag/env var section of the docs, where I want the "guide".

We have undocumented plans to completely refactor docs search. We will likely have separate searches for the technical reference and tutorials in the future.

@stirby stirby requested a review from matifali December 14, 2023 19:51
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

I didn't verify the correctness of content but approving to get it online, assuming the guide is already verified

@stirby stirby merged commit 0801760 into main Dec 15, 2023
@stirby stirby deleted the guides branch December 15, 2023 17:10
@github-actions github-actions bot locked and limited conversation to collaborators Dec 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants