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

doc: fix missing references to README.md #170

Merged
merged 1 commit into from
Sep 23, 2024

Conversation

dbkinder
Copy link
Contributor

Cross-repo references using an URL that only has the folder name cause links in the github.io site to go to the github.com site. Most of these uses want to link to the documentation (README.md) so add that where appropriate so links in the github.io site stay there.

Now that we've got those links fixed, we can reduce the complexity in the fix-github-md-refs script that was trying to add a README.md to folder names. Also added an area to keep test files for future work.

Cross-repo references using an URL that only has the folder name cause
links in the github.io site to go to the github.com site.  Most of these
uses want to link to the documentation (README.md) so add that where
appropriate so links in the github.io site stay there.

Now that we've got those links fixed, we can reduce the complexity in
the fix-github-md-refs script that was trying to add a README.md to
folder names. Also added an area to keep test files for future work.

Also updates the charter.md to indicate we've moved TSC information into
the docs folder in the community/TSC.rst file.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Copy link
Collaborator

@tomlenth tomlenth left a comment

Choose a reason for hiding this comment

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

LGTM

@dbkinder dbkinder merged commit cf69ef8 into opea-project:main Sep 23, 2024
1 check passed
@dbkinder dbkinder deleted the add-readme20 branch September 25, 2024 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants