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

use bookmark to skip folderlist when linking #2381

Merged
merged 2 commits into from
Jan 18, 2022

Conversation

ramthi
Copy link
Contributor

@ramthi ramthi commented Jan 15, 2022

Description

We need a way to take users directly to the content and have the heading section "Release", "License", "build status" etc visible. Currently there is no bookmark to link directly to that level. We either are able to skip that header or link to top level. This change is also in alignment with other language readme formats.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • 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)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Previewed in branch

Does This PR Require a Contrib Repo Change? NO

Answer the following question based on these examples of changes that would require a Contrib Repo Change:NA

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@ramthi ramthi requested a review from a team January 15, 2022 05:19
@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 17, 2022
@lzchen
Copy link
Contributor

lzchen commented Jan 18, 2022

@ramthi
Just fyi javascript repo isn't adhering to this format, might want to make a change for their repo as well. Also we should probably make the same change for contrib as well?

@ocelotl ocelotl merged commit 297b67e into open-telemetry:main Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants