Docs: Unify the Fedora Atomic Desktops docs in a single place #10
Labels
No labels
docs
kind
bug
kind
enhancement
kind
package-request
release
f40
release
f41
release
f42
release
f43
release
f44
release
f45
release/rawhide
No milestone
No project
No assignees
3 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
atomic-desktops/tracker#10
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Create a generic documentation page that include the common elements for all Atomic desktops.
Then we'll link this doc in the current ones and focus the variant specific docs to the relevant dekstop specific topics.
mentioned in issue fedora/docs/fedora-linux-documentation/release-docs-home#15
mentioned in issue #26
I've started this effort in https://gitlab.com/fedora/ostree/docs. PRs welcomed to convert all pages to more generic terms and merge the variations for each desktops into a single page or duplicated pages as needed.
We can also use https://gitlab.com/fedora/docs/docs-website/ui-bundle/-/issues/12.
Preview: https://fedora.gitlab.io/ostree/docs/fedora-atomic-desktops/
mentioned in issue #40
mentioned in issue fedora/docs/docs-website/pages#42
mentioned in merge request fedora/docs/docs-website/pages!62
Oh nice, didnt see this! Will jump in when there is time and add what I had in the old PR.
What does this mean for the other DE-specific doc pages? Should they be reduced, with a higher focus on linking to the generic doc pages?
Once those docs are ready, we should phase out and remove the per-desktops docs. No need to touch them for now until this is ready.
I will close my previous PR then I guess?
PR
Issue
I would say yes
@Siosm I looked at https://gitlab.com/fedora/ostree/docs and I am not sure what is missing. I see a couple TODO's in https://fedora.gitlab.io/ostree/docs/fedora-atomic-desktops/installation (First Run).
For Kinoite there is nothing important in https://docs.fedoraproject.org/en-US/fedora-kinoite/installation/#first-run.
And for Sway there is no "First Run": https://docs.fedoraproject.org/en-US/fedora-sericea/installation
For Fedora Budgie Atomic I could not find docs. The url does not work in https://docs.fedoraproject.org/en-US/emerging
So is there anything missing or needs to be edited?
We briefly discussed this section of the docs with Timothée, so I will take the liberty of sharing my opinion.
What I would do is install each of these variants and take a screenshot similar to the one for Fedora Silverblue. I was also thinking of installing F43 nightly composes and replacing the current Fedora Silverblue screenshot for consistency. Additionally, since we now have an officially available COSMIC Atomic variant at Atomic Desktops for Fedora, we should include it in this section as well.
Exactly what Hristo said. We need to find where the pages differ and add per-desktop sections in the docs here where there are difference.
mentioned in commit osalbahr/docs@d0a6d8a559
mentioned in merge request docs!52
Ok, I created a PR for Kinoite: https://gitlab.com/fedora/ostree/docs/-/merge_requests/7
Please let me know what you think.
For Sway, nothing seems to happen at startup. Should we just say "You can immediately start using Fedora Sway Atomic"?
!1492-03-10_at_4.31.20_PM](/uploads/37b8ac55796b44081d9f0319e0867445/Screenshot_1447-03-10_at_4.31.20_PM.png)
The same thing for Budgie Atomic.
!1492-03-10_at_4.55.10_PM](/uploads/8fad16a99234124c156f87a61ddbd033/Screenshot_1447-03-10_at_4.55.10_PM.png)
mentioned in commit osalbahr/docs@eedd09508a
mentioned in commit osalbahr/docs@449fc5edea
mentioned in commit osalbahr/docs@c08a7630ba
Yes, works for me
For consistency with Silverblue and Kinoite, wouldn't something like "On first startup, you can start using Fedora Sway Atomic." be more appropriate?
mentioned in commit osalbahr/docs@919a0b0846
mentioned in merge request docs!53
mentioned in commit osalbahr/docs@daec416677
The
Setting up Flathubsection of theGetting Startedpage differs from Atomic Desktops/Silverblue and Kinoite variants.https://fedora.gitlab.io/ostree/docs/fedora-atomic-desktops/getting-started/#flathub-setup
https://docs.fedoraproject.org/en-US/fedora-kinoite/getting-started/#flathub-setup
For unified docs, should we add the Kinoite figures or just mention that the process may differ slightly depending on the DE used?
The
Package layeringsection of theGetting Startedpage differs from Atomic Desktops/Silverblue and Fedora Sway Atomic variants.https://fedora.gitlab.io/ostree/docs/fedora-atomic-desktops/getting-started/#package-layering
https://docs.fedoraproject.org/en-US/fedora-sericea/getting-started/#package-layering
For unified docs, should we use
i3: A X11 tiling compositoror provide a different example?The Fedora Sway Atomic docs has separate Configuration Guide page:
https://docs.fedoraproject.org/en-US/fedora-sericea/configuration-guide/
How should we approach this in unified docs?
We should probably mention the Fedora Third Party tool now instead. Or mention that it differs per variant.
Yes, better to use the i3 example now that we have a sway variant so there is no need to layer it.
We should add the page with a clear mention somewhere that it is for Sway Atomic.
This is now done and live thanks to the work from @hrismarin.
Redirects are in place:
Remaining work:
https://pagure.io/fedora-l10n/tickets/issue/38-> localization/tickets#38set status to In progress
Great work, Hristo! Thank you for your contributions!
I believe I have done the needed work for this issue. Anything left?
https://gitlab.com/fedora/ostree/docs/-/merge_requests/8
@osalbahr wrote in #10 (comment):
Based on your expertise, would you consider adding a Fedora COSMIC Atomic screenshot to the Installing a Fedora Atomic Desktop page?
We have unified the docs, so we should probably consider closing this issue.We have one item left: localization/tickets#38 (comment).
How do I get SSH access to my fork? I see only HTTPS, even though I have uploaded my public key. So I can't push my changes.
Here is the commit in my GitLab fork:
gitlab.com/osalbahr/docs/-@d7cecc8357@osalbahr wrote in #10 (comment):
There is no SSH repo access in Fedora Forge yet. See forge/forge#27 and How to Clone a Repository using HTTPS Authentication in Fedora Forge. Currently, the SSH key can only be used for commit signing.
Ok. The PR should be ready for review now!