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

Initial doc layout with left navigation and page stubs #10

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

arewm
Copy link
Member

@arewm arewm commented Apr 26, 2024

Resolves: #1

Copy link

🚀 Preview is available at

@arewm
Copy link
Member Author

arewm commented Apr 26, 2024

Preview of the sidebar from a local render:
Screenshot 2024-04-26 at 10 18 03 AM

@arewm
Copy link
Member Author

arewm commented Apr 26, 2024

I missed the expansion of a couple of sections in the previous screengrab.
Screenshot 2024-04-26 at 10 20 17 AM

This replaces the ROOT text in the navbar for example.

Signed-off-by: arewm <[email protected]>
Copy link

🚀 Preview is available at

@TanyaShearonRH
Copy link

@arewm From comparison to what we mapped out, the above screen cap of navigation matches what we had in gdoc. I didn't see anything missing.

Few comments/questions:

  1. From one of the interviews of teams onboarding, the onboarding team's platform architect described needing to create the release plan admissions and reaching out to Konflux team. I"m assuming the onboarding team does not create the release plan object or release plan admissions---which is why we have releasing an application in the Advanced how-tos. Is this assumption correct?

  2. I would change title from "Installing" to "Installing Konflux"

  3. I wonder if we should re-order the topics in the Advanced How-tos section based on order in which that role would do complete the topics. For example,

Installing Konflux
Managing compliance with Enterprise Contract
Release an application
Creating a release plan
Creating a release plan admission
Managing multiple software versions
Managing a security fix

@TanyaShearonRH
Copy link

@arewm Also, consider changing "Inspecting your supply chain metadata" container to "Inspecting provenance and attestations."

@arewm
Copy link
Member Author

arewm commented Apr 26, 2024

@TanyaShearonRH, thanks for that feedback. Sounds good on all of it, see the latest commit (96abcdd) for the changes.

We can move the releases from advanced how-tos to the "normal" how-tos later if needed. The normal/advanced nature depends on how specific deployments of Konflux are configured and how they will be used. I left it in the advanced section for now.

Copy link

🚀 Preview is available at

@ryandeussing
Copy link

LGTM!

@arewm arewm merged commit d0104e8 into konflux-ci:main Apr 26, 2024
2 checks passed
@arewm arewm deleted the doc-outline branch April 26, 2024 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create the empty documentation pages
4 participants