Skip to content

reorganizing docs navigation for 2.2.0 and 2.2.1 #86

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

Merged
merged 1 commit into from
Apr 4, 2023

Conversation

mike-hoang
Copy link
Contributor

@mike-hoang mike-hoang commented Apr 4, 2023

What does this PR do / why we need it

Reorganized the sidebar navigation for 2.2.0 and 2.2.1-alpha with a focus on

  • Reducing the amount of general introduction topics; all persona docs removed – can add to landing page instead
  • Giving more visibility to creating and writing devfiles
  • Highlighting that Projects, Components, Commands, and Events are related to Authoring devfiles

Which issue(s) does this PR fix

Fixes devfile/api#1079

PR acceptance criteria

  • Unit Tests
  • E2E Tests
  • Documentation
    Update the sidebar if there is a new file added or an existing filename is changed

How to test changes / Special notes to the reviewer

@nx-cloud
Copy link

nx-cloud bot commented Apr 4, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 112f19d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 5 targets

Sent with 💌 from NxCloud.

@openshift-ci openshift-ci bot requested review from elsony and maysunfaisal April 4, 2023 12:44
@openshift-ci openshift-ci bot added the approved label Apr 4, 2023
@mike-hoang mike-hoang force-pushed the docs/reorg branch 2 times, most recently from 1bdda57 to cd84c3d Compare April 4, 2023 13:20
@@ -45,6 +45,7 @@ export const footerNavigation: FooterNavigation = {
{ name: 'Cloud Native Computing Foundation', href: 'https://www.cncf.io' },
{ name: 'Registry', href: '/' },
{ name: 'Documentation', href: `https://devfile.io/docs/${defaultVersion}/what-is-a-devfile` },
{ name: 'Community', href: `https://devfile.io/docs/${defaultVersion}/community` },
Copy link
Member

Choose a reason for hiding this comment

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

Good catch!

Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

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

I have one change request, a side from that everything else looks good.

Signed-off-by: Michael Hoang <mike.s.hoang@gmail.com>
Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Apr 4, 2023
@openshift-ci
Copy link

openshift-ci bot commented Apr 4, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: michael-valdron, mike-hoang

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

@mike-hoang mike-hoang merged commit 864d707 into devfile:main Apr 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganization of the doc pages
2 participants