Skip to content

docs: Cleanup version history file#17064

Merged
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:docs-cleanup-version-history
Jun 21, 2021
Merged

docs: Cleanup version history file#17064
phlax merged 3 commits intoenvoyproxy:mainfrom
phlax:docs-cleanup-version-history

Conversation

@phlax
Copy link
Copy Markdown
Member

@phlax phlax commented Jun 21, 2021

Signed-off-by: Ryan Northey ryan@synca.io

Commit Message: docs: Cleanup version history file
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]

Copy link
Copy Markdown
Contributor

@alyssawilk alyssawilk left a comment

Choose a reason for hiding this comment

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

Thanks for the clean up! Alas, looks like there's already merge conflicts.
Is there any valid use of single ticks around simple strings or should we fix-format this forward?
/wait

@alyssawilk alyssawilk self-assigned this Jun 21, 2021
@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jun 21, 2021

Alas, looks like there's already merge conflicts.

ill resolve now...

Is there any valid use of single ticks around simple strings or should we fix-format this forward?

not really no - it something we want to fix/check on an rst level tho - not with mad regexes i think

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the docs-cleanup-version-history branch from 930bd96 to ed206d7 Compare June 21, 2021 17:44
phlax added 2 commits June 21, 2021 19:00
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Copy link
Copy Markdown
Contributor

@alyssawilk alyssawilk left a comment

Choose a reason for hiding this comment

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

would love to see this land with a fix format change but I'm not going to block on it :-P

@phlax
Copy link
Copy Markdown
Member Author

phlax commented Jun 21, 2021

would love to see this land with a fix format change but I'm not going to block on it :-P

its too complex for the scope of this pr

i would also love for us to have a more general solution to this problem - there are a couple of blockers to that:

  • it needs to run against generated rst - i not just against this single file
  • there is not an easy way to enforce a literal over emphasized text (altho spellcheck does this in part)
  • there is not an easy way to check for ` over `` - this could be added, but it needs to work at the rst level to handle multi-lines etc

@phlax phlax merged commit 713b2a6 into envoyproxy:main Jun 21, 2021
leyao-daily pushed a commit to leyao-daily/envoy that referenced this pull request Sep 30, 2021
Signed-off-by: Ryan Northey <ryan@synca.io>
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.

2 participants