Skip to content

Raise warning if doc has underscores#652

Merged
dgarcia360 merged 3 commits intoscylladb:masterfrom
dgarcia360:raise-warning-doc-underscore
Mar 2, 2023
Merged

Raise warning if doc has underscores#652
dgarcia360 merged 3 commits intoscylladb:masterfrom
dgarcia360:raise-warning-doc-underscore

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

Closes #210

How to test this PR

  1. Clone this PR.
  2. Rename a file within the docs folder and add an underscore (e.g. docs/source/configuration/markdown.md -> docs/source/configuration/markdown_test.md).
  3. In the docs folder, run make preview.
  4. You should see the Warning: Document name contains underscores: configuartion/markdown_test.

@dgarcia360 dgarcia360 added the enhancement New feature or request label Dec 9, 2022
@dgarcia360 dgarcia360 mentioned this pull request Mar 2, 2023
18 tasks
Copy link
Copy Markdown
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

LGTM.
The message is displayed if there are one or more files that have underscores.

@dgarcia360 dgarcia360 merged commit e25a8ce into scylladb:master Mar 2, 2023
@dgarcia360 dgarcia360 mentioned this pull request Jun 2, 2023
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Warning when a file with underscored is used

2 participants