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

Fix Code of Conduct linking in docs #3820

Merged
merged 1 commit into from
Dec 14, 2023

Conversation

twz123
Copy link
Member

@twz123 twz123 commented Dec 14, 2023

Description

There was a symlink that pulled in the Code of Conduct from the repository root into the docs build. The link in the Code of Conduct was supposed to be working from within the docs.

Cleanup that situation by removing one Code of Conduct file and update the symlink. Also let changes to the Code of Conduct trigger the docs build workflow, so that these errors might be caught earlier in the future.

Fixes:

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Manual test
  • Auto test added

Checklist:

  • My code follows the style guidelines of this project
  • My commit messages are signed-off
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

There was a symlink that pulled in the Code of Conduct from the
repository root into the docs build. The link in the Code of Conduct was
supposed to be working from within the docs.

Cleanup that situation by removing one Code of Conduct file and update
the symlink. Also let changes to the Code of Conduct trigger the docs
build workflow, so that these errors might be caught earlier in the
future.

Fixes: 7aa222f ("Update link to Code of Conduct document")
Signed-off-by: Tom Wieczorek <[email protected]>
@twz123 twz123 added bug Something isn't working documentation Improvements or additions to documentation area/ci labels Dec 14, 2023
@twz123 twz123 requested a review from a team as a code owner December 14, 2023 15:06
@twz123 twz123 merged commit 6ced504 into k0sproject:main Dec 14, 2023
77 checks passed
@twz123 twz123 deleted the fix-code-of-conduct-links branch December 14, 2023 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants