Getting started container only #864
Conversation
doanac
force-pushed
the
getting-started-container-only
branch
from
7ce3ad2 to
58944a6
Compare
We are going to introduce the notion of signing up for container-only systems which requires a different signup flow. Signed-off-by: Andy Doan <[email protected]>
This splits our getting-started logic into a choice between: * Container only factories - the new way for most people * LmP based factories - legacy Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
doanac
force-pushed
the
getting-started-container-only
branch
from
58944a6 to
211acf8
Compare
This PR makes several changes to this doc to make it less verbose and more inlined with how we are pitching this to users. Notable changes: * Title change. People are coming here to "build containers", this doc will help them understand they are building a compose app. * Changing of the Target example to be on `main` and for a hwid of `amd64-linux` to match the Arduino experience. * Dropping references to Fioctl in favor of the UI in order to try and make a path for evaluting the product without needing Fioctl. * Dropping the "sea also" - the "CI for rootfs" is already showing up at the bottom of the page and we don't want to highlight this any more than necessary for now. * Dropping references to git mirroring and submodules. Let's encourage custom CI over that moving forward. Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
| @@ -0,0 +1,67 @@ | |||
| .. _gs-signup-co: | |||
|
|
|||
| Signing Up | |||
There was a problem hiding this comment.
I think we can move Signing Up into it's own section at the top of Getting Started. This avoids duplication.
The next page should probably be the "container-only" vs. "LmP" choice.
There was a problem hiding this comment.
I tried this but it screws up the navigation in confusing ways. The last part of the page has the "next" button. Depending on how things are ordered, you can be in the "lmp" signup and "next" actually takes you to container-only creation instructions. You can change order, but then the container-only "next" is wrong. It would be an easy trap for users to fall in.
The signup text is 18 lines, so duplication is probably worth it.
There was a problem hiding this comment.
@doanac FYI, we can always customize prev-next, including a conditional for a single page, such as if we want it to go somewhere else. Not sure that would be helpful here, but wanted to mention it!
| Creating Your Factory | ||
| ===================== | ||
|
|
||
| :ref:`ref-factory` is the start of your embedded OS, tailored specifically for your product. |
There was a problem hiding this comment.
There's a gap where someone is going to signup and then get stalled out by our user review policies for hours. I think we probably need a pointer to where they will start this process again after that delay. NOTE: we mention "start of your embedded OS" here which won't be true for the container-only solution. Maybe something like:
Once the signup process is complete, head to the :ref:`ref-factory` application at https://app.foundries.io.
When your account is created, it is not associated with any factories.
Create one by clicking :guilabel:`New Factory`.
There was a problem hiding this comment.
I tried to add something here: 24b22d5
Its not what you said, but I don't think giving a link to "create factory" is a good idea here, if they haven't yet read the paragraph below that says what to do.
Signed-off-by: Andy Doan <[email protected]>
Signed-off-by: Andy Doan <[email protected]>
doanac
changed the title
| @@ -0,0 +1,67 @@ | |||
| .. _gs-signup-co: | |||
|
|
|||
| Signing Up | |||
There was a problem hiding this comment.
@doanac FYI, we can always customize prev-next, including a conditional for a single page, such as if we want it to go somewhere else. Not sure that would be helpful here, but wanted to mention it!
source/reference-manual/factory/container-only-architecture.rst
Outdated
Show resolved
Hide resolved
source/reference-manual/factory/container-only-architecture.rst
Outdated
Show resolved
Hide resolved
source/reference-manual/factory/container-only-architecture.rst
Outdated
Show resolved
Hide resolved
source/reference-manual/factory/container-only-architecture.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Katrina Prosise <[email protected]>
doanac
force-pushed
the
getting-started-container-only
branch
from
1148533 to
b78a496
Compare
Co-authored-by: Katrina Prosise <[email protected]>
3 participants
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
Why merge this PR? What does it solve?
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.