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

Create troubleshooting section #501

Merged
merged 1 commit into from
Nov 9, 2022
Merged

Conversation

mjura
Copy link
Contributor

@mjura mjura commented Nov 8, 2022

No description provided.

@mjura mjura requested a review from nunix November 8, 2022 10:47
@kkaempf
Copy link
Contributor

kkaempf commented Nov 8, 2022

pinging @nunix here - my understanding was to create a 'toplevel' troubleshooting section with 'restore' (or 'booting') as subsections. 🤔

Copy link
Contributor

@nunix nunix left a comment

Choose a reason for hiding this comment

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

Modified sentences to active voice and rephrased the commands description.

Copy link
Contributor

@nunix nunix left a comment

Choose a reason for hiding this comment

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

Added a sub-level to Troubleshooting on the sidebar.js file

@nunix
Copy link
Contributor

nunix commented Nov 8, 2022

pinging @nunix here - my understanding was to create a 'toplevel' troubleshooting section with 'restore' (or 'booting') as subsections. 🤔

@kkaempf indeed, and I adjusted the sidebar.js to have such hierarchy.

@mjura mjura requested a review from nunix November 8, 2022 13:47
@kkaempf
Copy link
Contributor

kkaempf commented Nov 8, 2022

@kkaempf indeed, and I adjusted the sidebar.js to have such hierarchy.

Ok.
Shouldn't the file be renamed from troubleshooting-restore.md to troubleshooting.md then ?

@nunix
Copy link
Contributor

nunix commented Nov 8, 2022

@kkaempf indeed, and I adjusted the sidebar.js to have such hierarchy.

Ok. Shouldn't the file be renamed from troubleshooting-restore.md to troubleshooting.md then ?

As the file is in a "hierarchy", I would indeed rename the file but to "what" it troubleshoots (i.e. restore-elemental-node.md).
And the file name is more to know what it is, as the title on the sidebar is set manually on the file headers.

@mjura
Copy link
Contributor Author

mjura commented Nov 8, 2022

@kkaempf indeed, and I adjusted the sidebar.js to have such hierarchy.

Ok. Shouldn't the file be renamed from troubleshooting-restore.md to troubleshooting.md then ?

As the file is in a "hierarchy", I would indeed rename the file but to "what" it troubleshoots (i.e. restore-elemental-node.md). And the file name is more to know what it is, as the title on the sidebar is set manually on the file headers.

I think that filename is precise and it is explaining what is inside, but it is up to you I can rename to anything what you want.

@nunix
Copy link
Contributor

nunix commented Nov 8, 2022

I think that filename is precise and it is explaining what is inside, but it is up to you I can rename to anything what you want.

@mjura all good then, as in the long run we'll have more files in the section, it's more to avoid "conflicting" filenames.

@mjura mjura merged commit b6c38c6 into rancher:main Nov 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants