Skip to content
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

Initial docset #1

Merged
merged 6 commits into from
May 22, 2024
Merged

Initial docset #1

merged 6 commits into from
May 22, 2024

Conversation

osslate
Copy link
Contributor

@osslate osslate commented May 17, 2024

This PR adds the foundation for Daytona's documentation, based on the style of Daytona Enterprise's docs repository (https://github.com/daytonaio/enterprise-docs).

Once this is merged, we'll have a nice base to iterate on and make further changes to. In order to get this merged, I'd ask for strictly technical reviews and stylistic reviews on content and structure.

There are some small changes I am aware of from a previous review by @Tpuljak, that need to be made before marking the first docs release. These concern frontmatter data within each document for descriptive/SEO purposes, and some extra context for users around features added in 0.15.0.

I encourage opening issues in this repository for items that may need to be done, but aren't blockers to getting this initial PR merged. Thanks!

The style is based on the enterprise documentation. The initial docset
isn't exhaustive, but a foundation for further releases.

Signed-off-by: Fionn Kelleher <fionn@daytona.io>
Copy link
Member

@Tpuljak Tpuljak left a comment

Choose a reason for hiding this comment

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

Didn't want to overwhelm you with comments but I feel all of this should be addressed before the merge, especially the Providers part.

Again, please let us know if you need help, we're always available for a call.

README.md Outdated Show resolved Hide resolved
schemas/openapi.yaml Outdated Show resolved Hide resolved
src/components/Footer.astro Outdated Show resolved Hide resolved
src/components/Header.astro Outdated Show resolved Hide resolved
src/content/docs/reference/server.mdx Outdated Show resolved Hide resolved
src/content/docs/usage/dev-environments.mdx Show resolved Hide resolved
src/content/docs/usage/dev-environments.mdx Show resolved Hide resolved
src/styles/components/lois-backup.scss Outdated Show resolved Hide resolved
yarn.lock Outdated Show resolved Hide resolved
@ivan-burazin
Copy link
Member

Missing Port forwarding

@ivan-burazin
Copy link
Member

Add information about web IDE usage

Signed-off-by: Fionn Kelleher <fionn@daytona.io>
Signed-off-by: Fionn Kelleher <fionn@daytona.io>
@osslate
Copy link
Contributor Author

osslate commented May 22, 2024

@ivan-burazin as discussed async, we'll move the Port Forwarding info & more detailed Web IDE docs into separate PRs so we can get this merged.

As discussed in #1, we're going to do some restructuring work in a
separate PR to clarify Targets and Providers.

Signed-off-by: Fionn Kelleher <fionn@daytona.io>
Signed-off-by: Fionn Kelleher <fionn@daytona.io>
Signed-off-by: Fionn Kelleher <fionn@daytona.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants