Jetify Sandbox Docs Draft #2255
Open
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
Lagoja
force-pushed
the
jl/sandbox-docs
branch
from
e74c893
to
df81e07
Compare
LucilleH
requested changes
Sep 27, 2024
| title: "Jetify Docs", | ||
| tagline: "Instant, easy, and predictable shells and containers", | ||
| url: "https://www.jetify.com", | ||
| baseUrl: "/", |
There was a problem hiding this comment.
Wait, I don't think this is right. What are we trying to do here?
There was a problem hiding this comment.
We're trying to split the docs into Devbox and Cloud, so we can have urls like: https://www.jetify.com/devbox/docs and https://www.jetify.com/cloud/docs. Further down you'll see that each of the docs folders have their own route base paths:
docs: {
routeBasePath: "/devbox/docs",
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
docItemComponent: "@theme/ApiItem",
editUrl: "https://github.com/jetify-com/devbox/tree/main/docs/app/",
},Is there a better way to do this? It works well in Vercel, but not sure if it will interfere with other pages
LucilleH
approved these changes
Sep 27, 2024
| 1. Navigate to the **Projects** tab in the Jetify Dashboard | ||
| 2. Click on the `Create New` button on the top right corner of the page | ||
| 3. In the modal that appears, give the project a name, and then click "Create Project" | ||
| 4. In the new project, navigate to the Settings tab, and then click "Connect with Github" to connect the project to a Github repository |
There was a problem hiding this comment.
No longer need to navigate to the Settings tab unless you have created a sandbox for that project already (the empty state also has a Connect with Github or Choose Repository
| 4. In the new project, navigate to the Settings tab, and then click "Connect with Github" to connect the project to a Github repository | ||
| 5. Select the account and repository to link to the project. | ||
|
|
||
| Once the project is linked to a repository, developers can automatically create a new Sandbox for that repository by navigating to the project and clicking on the `New Sandbox` button. |
There was a problem hiding this comment.
Suggested change
| Once the project is linked to a repository, developers can automatically create a new Sandbox for that repository by navigating to the project and clicking on the `New Sandbox` button. | |
| Once the project is linked to a repository, developers can automatically create a new Devspace for that repository by navigating to the project and clicking on the `New Devspace` button. |
| @@ -11,7 +11,7 @@ If you don't already have Devbox installed, see our [Quickstart](https://www.jet | |||
|
|
|||
| You can authenticate with Jetify Cloud by running `devbox secrets auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. | |||
There was a problem hiding this comment.
Suggested change
| You can authenticate with Jetify Cloud by running `devbox secrets auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. | |
| You can authenticate with Jetify Cloud by running `devbox auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. |
Lagoja
force-pushed
the
jl/sandbox-docs
branch
from
ef22c7b
to
cc9bafe
Compare
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.
reorganize docs
remove deploy references
Adding content to Sandboxes Docs
add more content