8000 docs: Add Readme and command palette doc by grego952 · Pull Request #3818 · kyma-project/busola · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: Add Readme and command palette doc #3818

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 7 commits into from
Apr 4, 2025

Conversation

grego952
Copy link
Contributor
@grego952 grego952 commented Apr 3, 2025

Description

Changes proposed in this pull request:

  • Add Busola README.md
  • Add Command Palette doc
  • Add screenshots to Command Palette

Related issue(s)

Resolves #3787

Definition of done

  • The PR's title starts with one of the following prefixes:
    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation only changes
    • refactor: A code change that neither fixes a bug nor adds a feature
    • test: Adding tests
    • revert: Revert commit
    • chore: Maintainance changes to the build process or auxiliary tools, libraries, workflows, etc.
  • Related issues are linked. To link internal trackers, use the issue IDs like backlog#4567
  • Explain clearly why you created the PR and what changes it introduces
  • All necessary steps are delivered, for example, tests, documentation, merging

@grego952 grego952 changed the title Add Readme and command palette doc docs: Add Readme and command palette doc Apr 3, 2025
@grego952 grego952 enabled auto-merge (squash) April 3, 2025 05:00
@grego952 grego952 added the area/documentation Issues or PRs related to documentation label Apr 3, 2025
KonradPietocha
KonradPietocha previously approved these changes Apr 3, 2025
Co-authored-by: Mateusz Wisniewski <mwisnia97@gmail.com>
mrCherry97
mrCherry97 previously approved these changes Apr 4, 2025

![Quick navigation](assets/quick-navi.png)

- Enter `?` to see all navigation options and the resources' aliases. For example, if you want to see your namespaces, it's enough to type `ns`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Enter `?` to see all navigation options and the resources' aliases. For example, if you want to see your namespaces, it's enough to type `ns`.
- To see all navigation options and the resources' aliases, enter `?`. For example, if you want to see your namespaces, it's enough to type `ns`.

Copy link
Contributor

Choose a reason for hiding this comment

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

Generally, the SAP Style Guide recommends saying what to do before how (see Logical Sequence), and the examples indicate the preference of infinitives over gerunds. However, I'm leaving it up to you whether to apply the rule here. If you decide to go for it, please have a look at all the steps in this doc. I don't want to spam you with multiple suggestions of the same kind.

Co-authored-by: Iwona Langer <iwona.langer@sap.com>
@grego952 grego952 merged commit 893c674 into kyma-project:main Apr 4, 2025
9 checks passed
@grego952 grego952 deleted the command-palette branch April 4, 2025 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Request: Command Palette in Kyma Dashboard
4 participants
0