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

build/RELEASING.md: fix markdown formatting, no change in content #2263

Merged
merged 1 commit into from
Aug 18, 2021

Conversation

chalin
Copy link
Contributor

@chalin chalin commented Aug 18, 2021

If you view the file diff by ignoring whitespace changes, then you'll see that there are only whitespace changes: https://github.com/open-telemetry/opentelemetry-dotnet/pull/2263/files?diff=split&w=1:

@chalin chalin requested a review from a team August 18, 2021 17:30
@reyang
Copy link
Member

reyang commented Aug 18, 2021

@chalin would you help us to understand why would we want this change (e.g. what's the benefit)?

@chalin
Copy link
Contributor Author

chalin commented Aug 18, 2021

Hi @reyang

@chalin would you help us to understand why would we want this change (e.g. what's the benefit)?

Because the resulting file is easier to read. In particular, it is clearer, because of the proper indentation, which lines belong to any given step.

For example:

  • Before

    image

  • After

    image

The file is markdown, so doesn't it make sense to use proper markdown syntax?

I was originally going to modify step 16 (about updating the docs), but then noticed the formatting issues with the file. So I chose to submit the format fix first.

I'm working on OTel website improvements, and I'm documenting the current doc-update process for each language -- e.g., see open-telemetry/opentelemetry.io#472

@reyang
Copy link
Member

reyang commented Aug 18, 2021

@chalin got it, thanks for the context.

+1 on "The file is markdown, so doesn't it make sense to use proper markdown syntax?" 👍

I think it'll be better if we use ## header for each step, so if we need extra steps, we don't have to change the numbers all over the place. Doesn't have to be this PR though.

The inline code snippet also has improper indentation that we should fix, again, doesn't have to be in this PR.

@cijothomas
Copy link
Member

Thanks @chalin for the contribution!
(this doc is a temporary doc for the maintainers to do the release. Temporary till we find time to automate these steps via GH actions.)

@cijothomas cijothomas merged commit 95e6851 into open-telemetry:main Aug 18, 2021
@chalin chalin deleted the chalin-patch-1 branch August 18, 2021 20:19
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