Skip to content

Jetify Sandbox Docs Draft #2255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Oct 3, 2024
Merged

Jetify Sandbox Docs Draft #2255

merged 19 commits into from
Oct 3, 2024

Conversation

Lagoja
Copy link
Contributor

@Lagoja Lagoja commented Sep 5, 2024

  • reorganize docs

  • remove deploy references

  • Adding content to Sandboxes Docs

  • add more content

title: "Jetify Docs",
tagline: "Instant, easy, and predictable shells and containers",
url: "https://www.jetify.com",
baseUrl: "/",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait, I don't think this is right. What are we trying to do here?

Copy link
Contributor Author

@Lagoja Lagoja Sep 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh I see 👍

Copy link
Collaborator

@LucilleH LucilleH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@@ -8,7 +8,7 @@ This example shows how to build a simple Laravel application backed by MariaDB a

[Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/laravel)

[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox/?folder=examples/stacks/laravel)
[![Open In Devspace](/img/open-in-devspace.svg)](https://cloud.jetify.com/new/github.com/jetify-com/devbox?folder=examples/stacks/laravel)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[![Open In Devspace](/img/open-in-devspace.svg)](https://cloud.jetify.com/new/github.com/jetify-com/devbox?folder=examples/stacks/laravel)
[![Open In Devspace](/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/laravel)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we not want the docs url to point to www template pages?

Lagoja and others added 2 commits October 3, 2024 13:48
Signed-off-by: John Lago <[email protected]>
Co-authored-by: Lucille Hua <[email protected]>
Signed-off-by: John Lago <[email protected]>
@Lagoja Lagoja merged commit 3ed10ab into main Oct 3, 2024
25 of 29 checks passed
@Lagoja Lagoja deleted the jl/sandbox-docs branch October 3, 2024 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants