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

chore(kits-structure): rename kits folder name #1061

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

stephanbcbauer
Copy link
Member

@stephanbcbauer stephanbcbauer commented Oct 19, 2024

Description

Since we already mentioned "Kit folder name should be in kebab-case", this PR also adapts the example folders.

TBH no (only a view) KITs respects this rule :(

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@stephanbcbauer stephanbcbauer added the documentation Improvements or additions to documentation label Oct 19, 2024
@stephanbcbauer stephanbcbauer requested a review from a team October 19, 2024 20:26
@stephanbcbauer stephanbcbauer self-assigned this Oct 19, 2024
@stephanbcbauer
Copy link
Member Author

stephanbcbauer commented Oct 19, 2024

I am also wondering why we allow blanks in folder names? Shouldn't we define a naming convention for the filenames? Maybe also kebab-case? But this doesn't fit right now to page_adoption-view.md examples within this documentation.

├── page_adoption-view.md
├── page_software-operation-view.md
└── page_documentation.md
```

5. Inside the `NewKIT` folder, add a `SoftwareDevelopmentView` folder that contains a `page_software-development-view.md` file with the content that suits your use case
5. Inside the `new-kit` folder, add a `SoftwareDevelopmentView` folder that contains a `page_software-development-view.md` file with the content that suits your use case
Copy link
Member Author

@stephanbcbauer stephanbcbauer Oct 19, 2024

Choose a reason for hiding this comment

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

Why do we describe to add a SoftwareDevelopmentView (shouldn't this also be kebab-case?) but in the example the folder is named Software Development View

@stephanbcbauer stephanbcbauer merged commit 10fa3fa into main Nov 6, 2024
5 checks passed
@stephanbcbauer stephanbcbauer deleted the chore/correct-kits-folder-naming branch November 6, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants