-
Notifications
You must be signed in to change notification settings - Fork 120
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
Updated content for getting started docs section #1350
Conversation
split gettings started between codenvy.io and download. clarified plugin developer section.
Note that I'm suggesting we delete the |
this content is needed so didn't want to lose it but can't add it to the sharing page where it will go yet.
@@ -4,4 +4,6 @@ excerpt: "" | |||
layout: docs | |||
permalink: /docs/architecture/ | |||
--- | |||
Codenvy is composed of 8 Docker containers in a compose relationship. A browser is required for administration of the Codenvy system and to use the (optional) Eclipse Che browser IDE. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to specify what kind of browsers can be used or link?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think that's necessary.
| I am a... | Consider going to... | | ||
| --- | --- | | ||
| **Developer** who will be using Codenvy for my projects. | [*The User Guide*](../../docs/workspace-admin-intro/). This will teach you how to configure and use workspaces so that they bend to your magical programming will. | | ||
| **Developer** who will be creating custom extensions, plug-ins, and assemblies to package Codenvy and Eclipse Che into new tools. | [*The Developer Guide*](../../docs/rest-api). These documents provide all of our API interfaces, both internal and external. You will need to get comfortable with using the Eclipse Che SDK, and there is extensive additional SDK documentation that will make you an innovation beast. Also, if you are going to place your extensions into a Codenvy On-Prem, check out the additional [Plug-Ins](../../docs/developing-extensions/) administrator steps. | | ||
| **Developer** who will be creating custom extensions, plug-ins, and assemblies to package Codenvy and Eclipse Che into new tools. | [*Che Plugin Guide*](https://eclipse-che.readme.io/docs/introduction-1). These docs will help you setup your dev evironment and walk you through how to craete server- and client-side extensions and plugins. If you are going to place your extensions into a Codenvy On-Prem instance please [contact us for guidance](https://codenvy.com/contact/questions/). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
craete -> create .
[*Che Plugin Guide*](https://eclipse-che.readme.io/docs/introduction-1)
. This is a good example of why having all docs available on codenvy site. Take a look at https://codenvy.github.io/5_0_0-M8/docs/introduction-1/ . Even though it's not found in the navigation on right you can still view the page. Cross linking to che.github.io would be difficult I think.
So I think we should change https://eclipse-che.readme.io/docs/introduction-1
to ../../docs/introduction
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll fix the typo.
Although it's cool that you can see the page, it's confusing not to have it in the TOC and I can't jump to the other pages in that section so jumping away to the Che docs site is better. We can update the link after with the correct github.io link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it is confusing. We might consider adding this section to codenvy TOC. For now I think your edits are good and we can change later if we decide to do so.
@@ -4,10 +4,11 @@ excerpt: "Welcome to Codenvy!" | |||
layout: docs | |||
permalink: /docs/introduction/ | |||
--- | |||
Codenvy makes on-demand workspaces to give you a better agile experience. Codenvy SaaS is available for self-service at codenvy.com. You can also install Codenvy on your own infrastructure with Codenvy On-Prem. | |||
Codenvy makes Cloud workspaces for development teams featuring one-click Docker environments, team onboarding and a workspace platform | |||
for DevOps. Codenvy SaaS is available for self-service at codenvy.io. You can also install Codenvy on your own infrastructure with Codenvy On-Prem. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was the line break intended between 7-8?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no, i'll fix.
@JamesDrummond - updated typos. |
Updated content for getting started docs section
Content updates for the pages inside the Getting Started section of the Codenvy 5.0 docs.