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

[CI & docs] Rework of analysis docs + improved checks #256

Merged

Conversation

chalin
Copy link
Collaborator

@chalin chalin commented Jun 12, 2024

  • Contributes to Docs and analyses review and updates #247
  • Adds markdown linter + GH action
  • Runs markdown linter over all files, except old project analyses (it will check new analyses). Fixes done, and included in this PR.
  • Includes result of review and slight rework of templates (a few file renames).
  • Fixes broken links

@chalin chalin added documentation Improvements or additions to the TechDocs documentation CI/infra CI & infrastructure labels Jun 12, 2024
@chalin chalin force-pushed the chalin-im-analysis-docs-copyedits-2024-06-12 branch 3 times, most recently from 87ea428 to 79df3fc Compare June 12, 2024 16:44
Copy link
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

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

I appreciate the time you're spending to help organize and tidy up this repo @chalin

Runs markdown linter over all files, except old project analyses (it will check new analyses). Fixes done, and included in this PR.

I think linting the old project analyses is a good idea too (for later).

Where do you set the targets/filters for the linter?

@chalin chalin force-pushed the chalin-im-analysis-docs-copyedits-2024-06-12 branch from 79df3fc to 338687e Compare June 12, 2024 17:35
@chalin
Copy link
Collaborator Author

chalin commented Jun 12, 2024

I think linting the old project analyses is a good idea too (for later).

Where do you set the targets/filters for the linter?

In the NPM scripts.

I can't get the file filtering to work inside GH actions (it works locally), so I'm going to ignore all analyses for now.

@chalin chalin force-pushed the chalin-im-analysis-docs-copyedits-2024-06-12 branch from 338687e to e0f07ad Compare June 12, 2024 17:41
@nate-double-u
Copy link
Member

I can't get the file filtering to work inside GH actions (it works locally), so I'm going to ignore all analyses for now.

@RobertKielty, maybe you could take a look?

@chalin
Copy link
Collaborator Author

chalin commented Jun 12, 2024

All good. Checks are green. Merging.

@chalin chalin merged commit a15161f into cncf:main Jun 12, 2024
5 checks passed
@chalin chalin deleted the chalin-im-analysis-docs-copyedits-2024-06-12 branch June 12, 2024 23:24
@chalin chalin mentioned this pull request Jun 13, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure documentation Improvements or additions to the TechDocs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants