Merge Docs reorganization into Main #334
Merged
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
|
I have a script to check redirects by comparing the current live sitemap (attached to this comment) to the one built by this PR. Here are the reported broken links after applying redirects. I believe all of these are false positives due to limitations of the script ( Redirect listHere is the complete list of how the firebase.json redirects are set up:
Note that the |
szczys
requested review from
beriberikix,
ChrisGammell,
dylanswartz,
hasheddan and
sam-golioth
We have been slow to merge pull requests and that often meant the hosted preview expired before the PR was merged. Signed-off-by: Mike Szczys <mike@golioth.io>
Broad strokes to reogranize our docs. This commit does a wholesale move of the Hardware section into the Firmware section. Signed-off-by: Mike Szczys <mike@golioth.io>
Broad strokes to reorganize our docs. This commit renames the cloud section to device-management. Signed-off-by: Mike Szczys <mike@golioth.io>
* Fix slugs to use base of /firmware/hardware instead of /hardware * Fix links broken when moving hardware under firmware * Rebuild the hardware catalog to use new path Signed-off-by: Mike Szczys <mike@golioth.io>
This section will house LightDB State, LightDB stream, and Output Streams. Signed-off-by: Mike Szczys <mike@golioth.io>
Broad strokes to reorganize the Docs layout. Signed-off-by: Mike Szczys <mike@golioth.io>
Concepts section has been unrendered and unused for quite some time. Much of the information is out-of-date, and there is no reason to continue tracking it as we reorganize the Docs. Signed-off-by: Mike Szczys <mike@golioth.io>
Move the Logging, OTA, and Settings sections so the are immediately under Device Management. Signed-off-by: Mike Szczys <mike@golioth.io>
Move Light State and Stream to the data management section. Signed-off-by: Mike Szczys <mike@golioth.io>
This defines the Golioth color palette in custom CSS, and uses those define colors to replace most of the color codes. There should be no substantive appearance change as our initial site branding was very close the official color palette. This does make the colors uniformed and much easier to work with in the future. There are a set of dark/er/est and light/er/est colors that should be reviewed in a future commit. Signed-off-by: Mike Szczys <mike@golioth.io>
Use Akkurat font as part of Golioth branding. Signed-off-by: Mike Szczys <mike@golioth.io>
Move platfrom support from firmware/hardware section to landing page. Signed-off-by: Mike Szczys <mike@golioth.io>
* Tighten up summary to more closely reflect our current marketing. * Update navigation section to reflect relocated sections. Signed-off-by: Mike Szczys <mike@golioth.io>
* Add overview video
* Add CSS for YouTube video embed
* Usage:
* on YouTube page, click Share->Embed and copy code into Docusuarus
* remove the width and height properties
* add `class="youtube-embed"`
Signed-off-by: Mike Szczys <mike@golioth.io>
* Remove id and slug from pages where it was not necessary Signed-off-by: Mike Szczys <mike@golioth.io>
When mergin multiple PRs this link did not get updated to the new data-handling location. Signed-off-by: Mike Szczys <mike@golioth.io>
Remove swagger-ui styling that placed white text on a light background in the Authorize dialog Signed-off-by: Mike Szczys <mike@golioth.io>
* Change order of css include so swagger styles can be overridden * Add css file for fixing swagger-ui styles (especially in dark mode) Signed-off-by: Mike Szczys <mike@golioth.io>
Change the codeblock background from the blue tint to use a grey from our new branding colors. Signed-off-by: Mike Szczys <mike@golioth.io>
Previously, clicking on "Use Golioth Console (GUI)" would fold the section but not load a page. This commit loads the overview when the category is clicked. Signed-off-by: Mike Szczys <mike@golioth.io>
Getting started is a set of guides that should quickly move the user through to successfully connecting a device. This commit reduces the Golioth Console onboarding to two pages and an overview to help move the process along. Signed-off-by: Mike Szczys <mike@golioth.io>
The Web Console is our recommended happy path and should be the focus of the Getting Started section. This commit moves the Command Line Tools getting started section into a Tutorial item in Reference->Command Line Tools. Signed-off-by: Mike Szczys <mike@golioth.io>
Add a rudimentary set of Device Examples guides to the Getting Started section. These need fleshing out, but will walk user through running precompiled binaries and compiling example apps. Signed-off-by: Mike Szczys <mike@golioth.io>
This update is needed to fix an issue with indented admonitions Signed-off-by: Mike Szczys <mike@golioth.io>
These boards were listed but guides have not yet been written. This commit removes them from the list for now. They will be added back in the future when a guide for Reference Design Template follow-along hardware is added to the Docs. Signed-off-by: Mike Szczys <mike@golioth.io>
* Call out ESP-IDF instead of ESP32 * Summarize how Golioth works with the platform Signed-off-by: Mike Szczys <mike@golioth.io>
Clone commands for esp-idf and Golioth Firmware SDK now target a specific tag Signed-off-by: Mike Szczys <mike@golioth.io>
Correct the language name in codeblocks so highlighting works. Signed-off-by: Mike Szczys <mike@golioth.io>
* Move from single zephyr.md file to a subdirectory * Add section summary describint Zephyr and Golioth * Generalize the Zephyr set up process which was copied from our NXP-aimed guide Moving this to a subdirectory shouldn't affect any redirects as they are set up to all forward to the sections base address. Signed-off-by: Mike Szczys <mike@golioth.io>
Removing for brevity; having a second command here clutters the documentation. The fish shell is less common and it isn't hard for fish users to find the command to activate a Python venv. Signed-off-by: Mike Szczys <mike@golioth.io>
Update Zephyr install instructions to target the Golioth Firmware SDK. This change reflects the upcoming General Availability. People just starting to test should be using the Golioth Firmware SDK for Zephyr-based projects, rather than the Golioth Zephyr SDK. This commit renames partial files to differentiate them by starting with the target platform, specifying the SDK, and finally the computer arch: ``` <platform>-install-<golioth-sdk>[-for-<computer_arch>].md ``` Signed-off-by: Mike Szczys <mike@golioth.io>
Detail how to build the hello sample as a guide for building and running all samples. Signed-off-by: Mike Szczys <mike@golioth.io>
* Make subfolder for NCS getting started guide * Add overview of NCS with Golioth This change should not break any redirects as the existing path maps to the new summary page. Signed-off-by: Mike Szczys <mike@golioth.io>
* Update to install the Golioth Firmware SDK instead of the Golioth Zephyr SDK * Rename partial files to better reflect the content they contain * Generalize the install where possible Signed-off-by: Mike Szczys <mike@golioth.io>
Partials are used on both Zephyr and NCS setup but the workspace directory is different between the two. This commit adds a property to ensure the correct workspace directory name for the install. Signed-off-by: Mike Szczys <mike@golioth.io>
No changes were made to the content. This commit merely wraps long lines. Signed-off-by: Mike Szczys <mike@golioth.io>
Show how to compile and run the Hello sample on the nRF9160dk, with mention that this approach may be used with other boards. Signed-off-by: Mike Szczys <mike@golioth.io>
Add overview and descriptions of Application Services and Output Streams Signed-off-by: Mike Szczys <mike@golioth.io>
* Change file-name to match the desired slug * Update the summary each service Signed-off-by: Mike Szczys <mike@golioth.io>
Provide backgound on what Golioth is all about and describe what is found in thie getting started guide. Signed-off-by: Mike Szczys <mike@golioth.io>
* the pricing tiers redirect already exists on main and should be included in this branch. * the toolchain redirect was made long ago and is no longer relevant Signed-off-by: Mike Szczys <mike@golioth.io>
All redirect work up to this point happened only on the `dev` server. This commit copies those redirects so they will be applied to `prod` when merged. Signed-off-by: Mike Szczys <mike@golioth.io>
The partials directory was missing a leading underscore so it was being indexed by search engines. This commit adds an underscore to the directory name so that partials are not live on the site and updates all references with the new path. Signed-off-by: Mike Szczys <mike@golioth.io>
Partials should not have been indexed by search engines. This commit issues a permanent redirect to the root page for the `/partials-common` path. Signed-off-by: Mike Szczys <mike@golioth.io>
Remove https://docs.golioth.io mistakenly included in source URL as all sources shouldbe relative to the domain. Signed-off-by: Mike Szczys <mike@golioth.io>
Redirect the quickstart URLs for nrf91 and rt1060 to the new getting started pages for Zephyr and NCS. Signed-off-by: Mike Szczys <mike@golioth.io>
Because of a different in folder name and the use of the slug in the summary page front matter, some pages used `virtual-devices` and others used `virtual-device` (note the missing s) in their URL. All pages now use the version that ends with s. Signed-off-by: Mike Szczys <mike@golioth.io>
Redirect both /hardware/virtual-device and /hardware/virtual-devices to their new locations. Signed-off-by: Mike Szczys <mike@golioth.io>
|
Visit the preview URL for this PR (updated for commit b762423): https://golioth-docs-dev--pr334-develop-7bk15rja.web.app (expires Sun, 04 Feb 2024 15:19:02 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f53b02bdc98ce6f5593931ec4c339aa96bac84df |
Signed-off-by: Marko Puric <marko@golioth.io>
sam-golioth
approved these changes
Jan 8, 2024
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.
The
developbranch was used to stage major changes to how the Docs are organized. Each change was reviewed as it was added to the branch, so this PR doesn't require a fine-grained look. Let's focus on the structural changes for this review.This branch can be previewed on the development site:
https://docs.golioth.dev
Important issues for this PR:
Less important issues:
Anything that just needs some improvement or incremental update should be done after this merge.
Redirects:
Every time we move sections of the docs it breaks existing links from search engines, blog posts, parter documentation, browser bookmarks, etc. For this reason, we have included Firebase 301 redirects (permanently moved) that should cover 100% of the changes links.
Of course there is room for error in how these redirects work, so I'll post a generated list of redirects a s comment. If you have time, please skim the list and comment if you seen anything fishy.
Thank you!
This has been quite the project, thank you to all who pitched in with vision, brainstorming, and reviews.