docs: add landing pages and start content restructure #981
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #981 +/- ##
=======================================
Coverage 89.16% 89.16%
=======================================
Files 110 110
Lines 7493 7493
=======================================
Hits 6681 6681
Misses 633 633
Partials 179 179 ☔ View full report in Codecov by Sentry. |
these are just simple changes to improve presentation and interaction: - remove dev section - adjust grid arrangement for three cards - make entire card clickable
content is incorporated into howto and ref sections
- divides guides into subsections for setup, deployment, contributing - adds landing page text - adds howto content for developers
- divides content into components, configuration and debugging/testing - adds landing page text and structure - removes generic content on Ubuntu Pro, Landscape and WSL - adds reference content for developers (CLI and QA)
- adds landing page text and structure - minor fixes to wording and links
edibotopic
force-pushed
the
better-landing-pages
branch
from
56a1282 to
bccc9c4
Compare
|
Thanks a lot for the review @CarlosNihelton -- good spots!!! I might carry this PR into the next pulse so that we can discuss before finalising. (edit: or we could split your suggestions into a separate PR, as this one is big enough already) |
CarlosNihelton
approved these changes
Dec 3, 2024
Got it. I will resolve the conversations and return to those points in that PR. |
edibotopic
added a commit
that referenced
this pull request
Dec 13, 2024
In d03d56e a dedicated explanation section that includes a page describing the architecture of UP4W and its components. Previously, UP4W components and other topics (WSL and registry) where small, self-contained pages in the reference section. The explanation attempts to describe the individual components but also make connections between those components, so that the reader can better understand the software as a whole. In 26c7c28 a glossary of system components is included as a separate reference page. This can be quickly scanned for information about the major components, providing basic descriptions and any relevant commands. **NOTE:** these sections could be better linked with the rest of the documentation, but I want to wait until we merge the Ubuntu WSL documentation with this repo because that will involve some restructuring. The following commits address comments raised by @CarlosNihelton in [PR 981](#981): * 5d65a56 adds a note about potential references to outdated Go versions * 7ee851d references a command that can be used to start the Windows agent from the terminal Other minor changes include: * In the glossary, an outdated reference to Ubuntu advantage tools package mentioned by @CarlosNihelton in #981 (comment) is fixed * Updates to wordlist and links UDENG-5517
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This marks the start of a content restructure for the UP4W documentation.
The major changes include:
how-to guides>contributing to UP4Wandreference>debugging and testing)reference>UP4W components)Some planned changes are out of scope for this PR:
reference>UP4W componentsmay be consolidated further.back up and restore ubuntu WSL instancesmay be a better fit for the Ubuntu WSL docs and will be considered as part of separate work aimed at restructuring those docs.During the restructure there were some minor changes to wording and links.
UDENG-5304