Skip to content

Commit 3c441c8

Browse files
authored
Documentation Cleanup (#2592)
## Summary Cleanup Devspaces Documentation links ## How was it tested? Localhost testing ## Community Contribution License All community contributions in this pull request are licensed to the project maintainers under the terms of the [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0). By creating this pull request, I represent that I have the right to license the contributions to the project maintainers under the Apache 2 License as stated in the [Community Contribution License](https://github.com/jetify-com/opensource/blob/main/CONTRIBUTING.md#community-contribution-license). --------- Signed-off-by: John Lago <750845+Lagoja@users.noreply.github.com>
1 parent 71c2ca6 commit 3c441c8

File tree

71 files changed

+26
-469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+26
-469
lines changed

README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,6 @@ internally powered by `nix`.
3232

3333
## Demo
3434

35-
You can try out Devbox in your browser using the button below:
36-
37-
[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://auth.jetify.com/devspace/templates/tutorial)
38-
3935
The example below creates a development environment with `python 2.7` and
4036
`go 1.18`, even though those packages are not installed in the underlying
4137
machine:
@@ -97,9 +93,9 @@ ways, including:
9793

9894
## Quickstart: Fast, Deterministic Shell
9995

100-
In this quickstart well create a development shell with specific tools
96+
In this quickstart we'll create a development shell with specific tools
10197
installed. These tools will only be available when using this Devbox shell,
102-
ensuring we dont pollute your machine.
98+
ensuring we don't pollute your machine.
10399

104100
1. Open a terminal in a new empty folder.
105101

@@ -137,12 +133,12 @@ ensuring we don’t pollute your machine.
137133
devbox shell
138134
```
139135

140-
You can tell youre in a Devbox shell (and not your regular terminal) because
136+
You can tell you're in a Devbox shell (and not your regular terminal) because
141137
the shell prompt changed.
142138

143139
6. Use your favorite tools.
144140

145-
In this example we installed Python 3.10, so lets use it.
141+
In this example we installed Python 3.10, so let's use it.
146142

147143
```bash
148144
python --version

docs/README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
# Website
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
You can also test and contribute to our docs online using Jetify Devspace!
6-
7-
[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://cloud.jetify.com/new/github.com/jetify-com/devbox?folder=docs/app)
85

96
## Installation
107

@@ -35,3 +32,11 @@ This command generates static content into the `build` directory and can be serv
3532
When a pull request is opened, it will automatically deploy via CICD to a preview.
3633
When a pull request is merged, it will automatically deploy to production.
3734
Check https://www.jetify.com/devbox/ after merge to see the latest changes.
35+
36+
# Devbox Documentation
37+
38+
Welcome to the Devbox documentation! This documentation is built using Docusaurus and contains all the information you need to get started with Devbox.
39+
40+
## Contributing to Documentation
41+
42+
We welcome contributions to our documentation! If you find any issues or would like to suggest improvements, please feel free to open a pull request.

docs/app/cloud/devspace/_category_.json

-4
This file was deleted.

docs/app/cloud/devspace/faq.md

-42
This file was deleted.

docs/app/cloud/devspace/index.md

-68
This file was deleted.

docs/app/cloud/devspace/managing_devspaces.md

-30
This file was deleted.

docs/app/cloud/devspace/sharing_devspaces.md

-33
This file was deleted.

docs/app/cloud/devspace/start_a_devspace.md

-44
This file was deleted.

docs/app/cloud/faq.md

-9
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,6 @@ Jetify Deploys cost $0.10/vCPU per hour while your deployment is scheduled. If y
3131
3232
-->
3333

34-
## What are the specs of Jetify Devspace?
35-
36-
Devspaces by default have:
37-
38-
* 4 Dedicated vCPUs
39-
* 16 GB of RAM
40-
* 10 GB of user SSD Storage
41-
42-
Larger instances or more resources are available on request for paid customers! Contact us at [**help@jetify.com**](mailto:help@jetify.com?subject=Request More Resources)
4334

4435
## How does pricing for Jetify Cache work?
4536

docs/app/cloud/index.md

-4
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ Jetify Cloud is currently available in Early Access. We're actively working on a
1717

1818
Jetify Cloud currently includes:
1919

20-
**[Jetify Devspace](./devspace/index.md):** Create isolated, reproducible development environments for your team. Use Devbox to define the packages and configuration for your environment, and access your devspace anywhere from the browser.
21-
2220
**[Jetify Cache](./cache/index.md)**: Provides a secure, private cache to share packages across all your Devbox projects and environments, whether sourced from Nixpkgs or Flakes. Avoid rebuilding custom packages locally or in CI.
2321

2422
**[Jetify Secrets](./secrets/index.md)**: Securely store secrets and variables for all of your environments, and automatically synchronize them with your Devbox Shells and Scripts.
@@ -29,8 +27,6 @@ More features are coming soon, keep an eye on our [**blog**](https://www.jetify.
2927

3028
## Getting Started
3129

32-
- Create your first [**Jetify Devspace**](./devspace/index.md) and start developing in the cloud
3330
- Speed up your dev environments with [**Jetify Cache**](./cache/index.md)
3431
- Integrate Secrets with your Devbox project using [**Jetify Secrets**](./secrets/index.md)
3532
- Learn how to [**create your team**](./dashboard/creating_your_team.md) and [**invite members**](./dashboard/inviting_members.md)
36-
- Learn how to deploy your application with [**Jetify Deploys**](./deploys/index.md)

docs/app/cloud/sidebar.ts

-11
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,6 @@ const cloudSidebar: SidebarsConfig = {
66
type: "doc",
77
id: "index",
88
},
9-
{
10-
type: "category",
11-
label: "Jetify Devspace",
12-
collapsible: false,
13-
items: [
14-
{
15-
type: "autogenerated",
16-
dirName: "devspace",
17-
},
18-
],
19-
},
209
{
2110
type: "category",
2211
label: "Secrets",

docs/app/docs/devbox_cloud/beta_faq.md

-54
This file was deleted.

0 commit comments

Comments
 (0)