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

Make 3.0.0 the default on the site #5857

Merged
merged 3 commits into from
Jun 27, 2022

Conversation

cdrage
Copy link
Member

@cdrage cdrage commented Jun 22, 2022

What type of PR is this:

/kind documentation

What does this PR do / why we need it:

  • Moves the 3.0.0 documentation to current
  • Changes the "intro" page to "introduction" due to limitations of
    docusaurus index paging.

Which issue(s) this PR fixes:

Fixes #5842

PR acceptance criteria:

  • Documentation

How to test changes / Special notes to the reviewer:

Signed-off-by: Charlie Drage charlie@charliedrage.com

@netlify
Copy link

netlify bot commented Jun 22, 2022

Deploy Preview for odo-docusaurus-preview ready!

Name Link
🔨 Latest commit 5949c9d
🔍 Latest deploy log https://app.netlify.com/sites/odo-docusaurus-preview/deploys/62b9cbf0870aaf0008acf09a
😎 Deploy Preview https://deploy-preview-5857--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.

@odo-robot
Copy link

odo-robot bot commented Jun 22, 2022

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

@odo-robot
Copy link

odo-robot bot commented Jun 22, 2022

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

@odo-robot
Copy link

odo-robot bot commented Jun 22, 2022

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

@odo-robot
Copy link

odo-robot bot commented Jun 22, 2022

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

@odo-robot
Copy link

odo-robot bot commented Jun 22, 2022

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

@valaparthvi
Copy link
Contributor

/approve
/lgtm

All the updated links are in place.

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

openshift-ci bot commented Jun 23, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: valaparthvi

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 Jun 23, 2022
@valaparthvi
Copy link
Contributor

/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Jun 23, 2022
@valaparthvi
Copy link
Contributor

/cancel lgtm

@valaparthvi valaparthvi removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 23, 2022
@valaparthvi
Copy link
Contributor

/hold cancel

Read the docs on the main page still points to 2.5.0 docs.

@valaparthvi valaparthvi removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. Required by Prow. label Jun 23, 2022
@rm3l
Copy link
Member

rm3l commented Jun 24, 2022

image

The text in the top banner seems a bit repetitive to me when we are browsing the 3.0.0 docs, especially the last sentence: For up-to-date documentation, see the latest version (3.0.0 (Alpha 2) 🚧).
Would it be possible to hide the last sentence when we are already reading the docs for the latest version?

@valaparthvi
Copy link
Contributor

image

The text in the top banner seems a bit repetitive to me when we are browsing the 3.0.0 docs, especially the last sentence: For up-to-date documentation, see the latest version (3.0.0 (Alpha 2) 🚧). Would it be possible to hide the last sentence when we are already reading the docs for the latest version?

I think the last sentence is supposed to talk about the stable 2.5.0 version, I remember seeing it somewhere.

@cdrage
Copy link
Member Author

cdrage commented Jun 24, 2022

/hold cancel

Read the docs on the main page still points to 2.5.0 docs.

Clear your cookies :) probably why it was doing that.

@cdrage
Copy link
Member Author

cdrage commented Jun 24, 2022

image
The text in the top banner seems a bit repetitive to me when we are browsing the 3.0.0 docs, especially the last sentence: For up-to-date documentation, see the latest version (3.0.0 (Alpha 2) 🚧). Would it be possible to hide the last sentence when we are already reading the docs for the latest version?

I think the last sentence is supposed to talk about the stable 2.5.0 version, I remember seeing it somewhere.

I've removed these! :) it shouldn't appear anymore and instead use the 🚧 emoji and that it's "alpha" to indicate it's unreleased.

@valaparthvi valaparthvi requested a review from rm3l June 27, 2022 06:25
@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 27, 2022
<!--
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:**

* Moves the 3.0.0 documentation to current
* Changes the "intro" page to "introduction" due to limitations of
  docusaurus index paging.

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

Fixes redhat-developer#5842

**PR acceptance criteria:**

- [X] Documentation

**How to test changes / Special notes to the reviewer:**

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 27, 2022
@cdrage
Copy link
Member Author

cdrage commented Jun 27, 2022

Fixed and ready for another review 👍

@sonarcloud
Copy link

sonarcloud bot commented Jun 27, 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.5% 0.5% Duplication

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. Required by Prow. label Jun 27, 2022
@cdrage
Copy link
Member Author

cdrage commented Jun 27, 2022

Let's merge this in! Got one approval for docs (that's only what's needed). We can see what issues arise this week with broken links, but I've covered all use cases for the README.md as well as wiki + main page (no docusaurus errors)

@cdrage cdrage merged commit e1a16a6 into redhat-developer:main Jun 27, 2022
cdrage added a commit to cdrage/odo that referenced this pull request Aug 31, 2022
* Make 3.0.0 the default on the site

<!--
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:**

* Moves the 3.0.0 documentation to current
* Changes the "intro" page to "introduction" due to limitations of
  docusaurus index paging.

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

Fixes redhat-developer#5842

**PR acceptance criteria:**

- [X] Documentation

**How to test changes / Special notes to the reviewer:**

Signed-off-by: Charlie Drage <charlie@charliedrage.com>

* fix broken links

* fix more links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

Switch main site to 3.0.0 documentation
3 participants