Skip to content

Reorganize and separate language / framework tutorials. #6071

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 8, 2022
Merged

Reorganize and separate language / framework tutorials. #6071

merged 4 commits into from
Sep 8, 2022

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Aug 31, 2022 •
edited
Loading

Reorganize and separate language / framework tutorials.

What type of PR is this:

/kind documentation

What does this PR do / why we need it:

This PR:

  • Uses MDX to make quickstart and deployment guides modular / easier to
    maintain
  • Separates tutorials / guides to different docs

Which issue(s) this PR fixes:

Closes #6051

@netlify
Copy link

netlify bot commented Aug 31, 2022 •
edited
Loading

✅ Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit c5e9c1b
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/6318ada694fbab000dd70532
😎 Deploy Preview https://deploy-preview-6071--odo-docusaurus-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@openshift-ci openshift-ci bot requested review from dharmit and valaparthvi August 31, 2022 19:21
@cdrage cdrage force-pushed the fix-quickstart-guide branch from e59d4b1 to ebc00f9 Compare August 31, 2022 19:23
@odo-robot
Copy link

odo-robot bot commented Aug 31, 2022 •
edited
Loading

Unit Tests on commit f9c8909 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Aug 31, 2022 •
edited
Loading

Validate Tests on commit f9c8909 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Aug 31, 2022 •
edited
Loading

Kubernetes Tests on commit f9c8909 finished successfully.
View logs: TXT HTML

@odo-robot
Copy link

odo-robot bot commented Aug 31, 2022 •
edited
Loading

OpenShift Tests on commit f9c8909 finished successfully.
View logs: TXT HTML

This was referenced Sep 1, 2022
Closed
Closed
@rm3l rm3l self-assigned this Sep 5, 2022
valaparthvi
valaparthvi suggested changes Sep 6, 2022
View reviewed changes
Copy link
Contributor

@valaparthvi valaparthvi left a comment

Choose a reason for hiding this comment

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

This change looks good!

@cdrage cdrage force-pushed the fix-quickstart-guide branch from 7ed223b to c3574d5 Compare September 6, 2022 12:31
@cdrage
Copy link
Member Author

cdrage commented Sep 6, 2022

Ready for another review 💯

@odo-robot
Copy link

odo-robot bot commented Sep 6, 2022 •
edited
Loading

Windows Tests (OCP) on commit f9c8909 finished successfully.
View logs: TXT HTML

@dharmit
Copy link
Member

dharmit commented Sep 7, 2022

Off-topic, but I think we need collapsible sections in the sidebar. It requires scrolling now.

@cdrage
Copy link
Member Author

cdrage commented Sep 7, 2022

Off-topic, but I think we need collapsible sections in the sidebar. It requires scrolling now.

IMHO I think we should keep it open / no collapse so we can view everything at once, and instead reduce the font size (we previously had the font sized increased)

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Sep 7, 2022
@cdrage cdrage force-pushed the fix-quickstart-guide branch from 36103a5 to c41fcac Compare September 7, 2022 12:34
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. Required by Prow. label Sep 7, 2022
@cdrage
Copy link
Member Author

cdrage commented Sep 7, 2022

Fixed @valaparthvi

@cdrage cdrage force-pushed the fix-quickstart-guide branch from c41fcac to 51d697e Compare September 7, 2022 12:35
@cdrage
Reorganize and separate language / framework tutorials.
8ed4d80 
<!--
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:**

This PR:
* Uses MDX to make quickstart and deployment guides modular / easier to
  maintain
* Separates tutorials / guides to different docs

**Which issue(s) this PR fixes:**
<!--
Specifying the issue will automatically close it when this PR is merged
-->

Fixes PART of redhat-developer#6051

Signed-off-by: Charlie Drage <[email protected]>
@cdrage
Update based on review
b21c9fd 
Signed-off-by: Charlie Drage <[email protected]>
@cdrage
fix index page
7e5f3e4 
Signed-off-by: Charlie Drage <[email protected]>
@cdrage
fix rebase
c5e9c1b
@cdrage cdrage force-pushed the fix-quickstart-guide branch from 51d697e to c5e9c1b Compare September 7, 2022 14:41
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 7, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.6% 0.6% Duplication

@dharmit
Copy link
Member

dharmit commented Sep 8, 2022

Off-topic, but I think we need collapsible sections in the sidebar. It requires scrolling now.

IMHO I think we should keep it open / no collapse so we can view everything at once, and instead reduce the font size (we previously had the font sized increased)

We switched to the open view because there weren't many items. But now there are so many items that it requires scrolling through the sidebar.

Reducing the font size would require increasing the zoom, and again it would lead to the scrolling problem.

@cdrage
Copy link
Member Author

cdrage commented Sep 8, 2022

Off-topic, but I think we need collapsible sections in the sidebar. It requires scrolling now.

IMHO I think we should keep it open / no collapse so we can view everything at once, and instead reduce the font size (we previously had the font sized increased)

We switched to the open view because there weren't many items. But now there are so many items that it requires scrolling through the sidebar.

Reducing the font size would require increasing the zoom, and again it would lead to the scrolling problem.

As a compromise, let's re-add collapsible navbars with the default being open?

We can implement this on another PR. We need this PR in so we can unblock / remove conflicts + rebasing from other PR's such as #6087

@cdrage cdrage mentioned this pull request Sep 8, 2022
Closed
@dharmit
Copy link
Member

dharmit commented Sep 8, 2022

/lgtm
/approve

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Sep 8, 2022
@openshift-ci
Copy link

openshift-ci bot commented Sep 8, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dharmit

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. label Sep 8, 2022
@openshift-merge-robot openshift-merge-robot merged commit 77750ec into redhat-developer:main Sep 8, 2022
@valaparthvi valaparthvi mentioned this pull request Sep 9, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rm3l rm3l rm3l left review comments

@valaparthvi valaparthvi valaparthvi requested changes

@dharmit dharmit Awaiting requested review from dharmit

Assignees

@rm3l rm3l

@dharmit dharmit

@valaparthvi valaparthvi

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. Required by Prow. lgtm Indicates that a PR is ready to be merged. Required by Prow.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Reorganize the quickstart guide / separate into dev and deploy guides
5 participants
@cdrage @dharmit @rm3l @valaparthvi @openshift-merge-robot