Adds .NET 6.0 as a quickstart example #5774
Conversation
<!-- Thank you for opening a PR! Here are some things you need to know before submitting: 1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines 2. Label this PR accordingly with the '/kind' line 3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests 4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline Documentation: If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing --> **What type of PR is this:** <!-- Add one of the following kinds: /kind bug /kind feature /kind cleanup /kind tests Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well. --> /kind documentation **What does this PR do / why we need it:** Adds .NET to the quickstart guide as an example. Including building the container, running dev as well as deploy. **Which issue(s) this PR fixes:** <!-- Specifying the issue will automatically close it when this PR is merged --> Fixes 1/2 of redhat-developer#5746 **PR acceptance criteria:** - [X] Documentation **How to test changes / Special notes to the reviewer:** Signed-off-by: Charlie Drage <charlie@charliedrage.com>
✅ Deploy Preview for odo-docusaurus-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
docs/website/versioned_docs/version-3.0.0/user-guides/quickstart.md
Outdated
Show resolved
Hide resolved
| Based on the files in the current directory odo detected | ||
| Language: javascript | ||
| Project type: nodejs | ||
| The devfile "nodejs" from the registry "DefaultDevfileRegistry" will be downloaded. |
There was a problem hiding this comment.
I guess it depends on Alizer, but it is weird to me that "nodejs" was detected, and not "dotnet" :-)
There was a problem hiding this comment.
I know :( Alizer wasn't able to detect it correctly. I'll be opening up an issue for this.
There was a problem hiding this comment.
FYI, I just found a similar issue: redhat-developer/alizer#83
Signed-off-by: Charlie Drage <charlie@charliedrage.com>
There was a problem hiding this comment.
Thanks for the changes. After re-reading, I added a few more comments.
Also, we could change the intro sentence since there are now multiple languages in this guide. It currently reads:
In this guide, we will be using odo to create a "Hello World" application with Node.js
Even if users select a .NET tab..
docs/website/versioned_docs/version-3.0.0/user-guides/quickstart.md
Outdated
Show resolved
Hide resolved
|
Good catches! I've gone ahead and updated it again. I completely missed those parts. Thanks :) |
Signed-off-by: Charlie Drage <charlie@charliedrage.com>
|
Kudos, SonarCloud Quality Gate passed!
|
openshift-ci
bot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: rm3l The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
|
Manual merge (sorry!) since Kubernetes integration tests are failing which they really shouldn't have. Need to have this merged for tomorrow. |
| * Node.js | ||
| * .NET | ||
|
|
||
| A full list of example applications can be viewed with the `odo registry` command. |
There was a problem hiding this comment.
Think about this as a user. If I want to see example applications, how does it make sense to run a registry command? IMO, we are having a terrible UX where commands don't map to the actual thing. This is not feedback for this PR, but something that we should really think about when revamping odo to v3. @kadel @deboer-tim @serenamarie125
| ```console | ||
| $ dotnet new mvc --name app | ||
|
|
||
| Welcome to .NET 6.0! | ||
| --------------------- | ||
| SDK Version: 6.0.104 | ||
|
|
||
| ... | ||
|
|
||
| The template "ASP.NET Core Web App (Model-View-Controller)" was created successfully. | ||
| This template contains technologies from parties other than Microsoft, see https://aka.ms/aspnetcore/6.0-third-party-notices for details. | ||
|
|
||
| Processing post-creation actions... | ||
| Running 'dotnet restore' on /Users/user/app/app.csproj... | ||
| Determining projects to restore... | ||
| Restored /Users/user/app/app.csproj (in 84 ms). | ||
| Restore succeeded. | ||
| ``` |
There was a problem hiding this comment.
@cdrage this should have been tabbed. If you look at how it's rendered, it's not really under the point 1 that you have written above. Something like this:
| ```console | |
| $ dotnet new mvc --name app | |
| Welcome to .NET 6.0! | |
| --------------------- | |
| SDK Version: 6.0.104 | |
| ... | |
| The template "ASP.NET Core Web App (Model-View-Controller)" was created successfully. | |
| This template contains technologies from parties other than Microsoft, see https://aka.ms/aspnetcore/6.0-third-party-notices for details. | |
| Processing post-creation actions... | |
| Running 'dotnet restore' on /Users/user/app/app.csproj... | |
| Determining projects to restore... | |
| Restored /Users/user/app/app.csproj (in 84 ms). | |
| Restore succeeded. | |
| ``` | |
| ```console | |
| $ dotnet new mvc --name app | |
| Welcome to .NET 6.0! | |
| --------------------- | |
| SDK Version: 6.0.104 | |
| ... | |
| The template "ASP.NET Core Web App (Model-View-Controller)" was created successfully. | |
| This template contains technologies from parties other than Microsoft, see https://aka.ms/aspnetcore/6.0-third-party-notices for details. | |
| Processing post-creation actions... | |
| Running 'dotnet restore' on /Users/user/app/app.csproj... | |
| Determining projects to restore... | |
| Restored /Users/user/app/app.csproj (in 84 ms). | |
| Restore succeeded. | |
| ``` | |
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| You can now access the application at [127.0.0.1:40001](http://127.0.0.1:40001) in your local browser and start your development loop. `odo` will watch for changes and push the code for real-time updates. | ||
|
|
||
|
|
||
| ## Step 3. Deploying your application to the world (`odo deploy`) |
There was a problem hiding this comment.
"to the world", really? We still don't claim odo to be a production ready tool. Inner loop and outer loop, that's it. Nitpicking, I know. Also, not a part of this PR, I know. 😉
There was a problem hiding this comment.
Want to open a PR to fix it 😜
| @@ -389,6 +492,204 @@ Your Devfile has been successfully deployed | |||
|
|
|||
| Your application has now been deployed to the Kubernetes cluster with Deployment, Service, and Ingress resources. | |||
|
|
|||
| Test your application by visiting the `DOMAIN_NAME` variable that you had set in the `devfile.yaml`. | |||
There was a problem hiding this comment.
I wonder why this statement doesn't show up on the quickstart guide on the site. 🤔
It shows up only once at the end of the guide. Maybe I'm missing something.
There was a problem hiding this comment.
Yup! Since this is part of odo deploy, you can visit the ingress you made with the domain name at the end of the quickstart guide.
* Adds .NET 6.0 as a quickstart example <!-- Thank you for opening a PR! Here are some things you need to know before submitting: 1. Please read our developer guideline: https://github.com/redhat-developer/odo/wiki/Dev:-odo-Dev-Guidelines 2. Label this PR accordingly with the '/kind' line 3. Ensure you have written and ran the appropriate tests: https://github.com/redhat-developer/odo/wiki/Dev:-Writing-and-running-tests 4. Read how we approve and LGTM each PR: https://github.com/redhat-developer/odo/wiki/Pull-Requests:-Review-guideline Documentation: If you are pushing a change to documentation, please read: https://github.com/redhat-developer/odo/wiki/Documentation:-Contributing --> **What type of PR is this:** <!-- Add one of the following kinds: /kind bug /kind feature /kind cleanup /kind tests Feel free to use other [labels](https://github.com/redhat-developer/odo/labels) as needed. However one of the above labels must be present or the PR will not be reviewed. This instruction is for reviewers as well. --> /kind documentation **What does this PR do / why we need it:** Adds .NET to the quickstart guide as an example. Including building the container, running dev as well as deploy. **Which issue(s) this PR fixes:** <!-- Specifying the issue will automatically close it when this PR is merged --> Fixes 1/2 of redhat-developer#5746 **PR acceptance criteria:** - [X] Documentation **How to test changes / Special notes to the reviewer:** Signed-off-by: Charlie Drage <charlie@charliedrage.com> * Update based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com> * Upddate based on review Signed-off-by: Charlie Drage <charlie@charliedrage.com>
What type of PR is this:
/kind documentation
What does this PR do / why we need it:
Adds .NET to the quickstart guide as an example. Including building the
container, running dev as well as deploy.
Which issue(s) this PR fixes:
Fixes 1/2 of #5746
PR acceptance criteria:
How to test changes / Special notes to the reviewer:
Signed-off-by: Charlie Drage charlie@charliedrage.com