Skip to content

Conversation

ADubhlaoich
Copy link
Member

Proposed changes

This commit removes the CHANGELOG file from the repository, as it was not being used. The README and CONTRIBUTING files have been streamlined, and now more accurately reflect the user flow when contributing.

Some GitHub templates have been updated to reflect these changes, and also include relative links instead of axiomatic blobs, which will make finding and updating links easier in the future.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

This commit removes the CHANGELOG file from the repository, as it was
not being used. The README and CONTRIBUTING files have been streamlined,
and now more accurately reflect the user flow when contributing.

Some GitHub templates have been updated to reflect these changes, and
also include relative links instead of axiomatic blobs, which will make
finding and updating links easier in the future.
@ADubhlaoich ADubhlaoich requested review from a team as code owners July 3, 2025 11:06
@github-actions github-actions bot added tooling Back end, repository, Hugo, and all things not related to content process documentation Documentation related to how the repository or documention itself is managed. labels Jul 3, 2025
Copy link

github-actions bot commented Jul 3, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/783/

@ADubhlaoich ADubhlaoich linked an issue Jul 3, 2025 that may be closed by this pull request
@ADubhlaoich ADubhlaoich merged commit 469dd7e into main Jul 4, 2025
8 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-readmes branch July 4, 2025 09:12
lamATnginx pushed a commit that referenced this pull request Jul 15, 2025
This commit removes the CHANGELOG file from the repository, as it was
not being used. The README and CONTRIBUTING files have been streamlined,
and now more accurately reflect the user flow when contributing.

Some GitHub templates have been updated to reflect these changes, and
also include relative links instead of axiomatic blobs, which will make
finding and updating links easier in the future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

process documentation Documentation related to how the repository or documention itself is managed. tooling Back end, repository, Hugo, and all things not related to content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken links to internal style guide

3 participants