-
Notifications
You must be signed in to change notification settings - Fork 27
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 User Guide Reorg and Introduction of Customer Life Cycles #685
Conversation
Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
Docs for 58b547e are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2595/docs/artifacts/html/index.html |
@mike-scott @kprosise @angolini @caiotpereira Draft view so you can check the compiled page. |
From the previous discussion, I understood we would replace the part "User Guide" with another part; from the PR, it would be the "Life Cycle / Customer Journey / Good Name Here". @kprosise, do you know if there is a way we can display levels 1 and 2 on the sidebar? |
Overall, I like the change in the order. But I still don't like the sidebar |
@angolini I agree with displaying multiple levels on the side bar, I played with it for a bit but couldn't achieve anything. |
In the past, I have also tried and could not find a way. |
I did a sync with Mike on this and from this I will propose a few more changes to this, the biggest one being dropping the new life cycle section. We will cover personas at the top of each section. |
@angolini @vanmaegima let me look into the side bar levels thing. It should be possible, will likely just require modding the theme a bit. Let me spend a little time today to see what I can come up with. |
58b547e
to
79aede9
Compare
Updated docs with suggestions from @mike-scott , PTAL. |
Re: side bar levels, it will unsurprisingly require a deeper dive into what is going on. All my attempts today at changing anything related to the theme produce nothing. I will spend a bit more time looking into it out of curiosity before moving on for the time being. |
79aede9
to
b6f3e22
Compare
Docs for b6f3e22 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2598/docs/artifacts/html/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am liking this reorganization so far!
@@ -62,7 +75,6 @@ OE/Yocto Project, the Linux microPlatform™ and Docker®. | |||
reference-manual/index | |||
reference-manual/docker/docker | |||
reference-manual/boards/boards | |||
reference-manual/qemu/qemu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be done after the merge, but for all pages moved to a different section, we should likely add a redirect in source/conf.py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kprosise I'm reworking this PR, can I get an example on what do you mean with this comment? I see the redirects in conf.py but it's not clear for me what it means.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just so that anyone going to latest/reference-manual/qemu/qemu.html
and the other pages don't receive a no-such-page error, as the pages will now be under latest/user-guide/qemu/*
, but it's not too important at the moment.
Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
This aims to improve the top to bottom flow of our documentation. Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
b6f3e22
to
171b6e9
Compare
@kprosise I reduced the scope on this PR (removed personas and new pages that I'll cover on the next PR per discussion with Mike). Now it only covers:
|
Docs for 171b6e9 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2622/docs/artifacts/html/index.html |
Looks good to me! We can do future tweaks if need be, but I think this is a good step towards the reorganization goal! The redirect works as intended. :) |
@kprosise We can merge this whenever you're ready then! I'll send another one after this is merged. |
PR Template and Checklist
Please complete as much as possible to speed up the reviewing process.
Readiness and adding reviewers as appropriate is required.
All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.
Readiness
Overview
This brings a User Guide reorganization based on the customer journey so steps can be approached in a understandable way.
This also brings the Customer Life Cycle view of the docs, which covers a doc view based on journey/personas.
Checklist
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.