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.

Sign up for GitHub

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

Jump to bottom

docs: fix links for public docs #19018

Merged
merged 5 commits into from
Dec 17, 2021
Merged

docs: fix links for public docs #19018

merged 5 commits into from
Dec 17, 2021

Conversation

kriswuollett
Copy link
Contributor

Previously doc paths were not updated within #8027. Resolves #19017.

Signed-off-by: Kristopher Wuollett kristopher.wuollett@gmail.com

Commit Message: docs: fix links for public docs
Additional Description: fixes links from file migration in #8027
Risk Level: Low
Testing: N/A
Docs Changes: Yes
Release Notes: N/A
Platform Specific Features: N/A

@kriswuollett
docs: fix links for public docs
bb10e0a 
Previously doc paths were not updated within envoyproxy#8027. Resolves envoyproxy#19017.

Signed-off-by: Kristopher Wuollett <kristopher.wuollett@gmail.com>
@repokitteh-read-only
Copy link

Hi @kriswuollett, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #19018 was opened by kriswuollett.

see: more, trace.

@kriswuollett
Copy link
Contributor Author

Does the redirects.txt file need to be updated too for observability/access_log?

@phlax phlax self-assigned this Nov 16, 2021
@phlax
Copy link
Member

phlax commented Nov 16, 2021

Does the redirects.txt file need to be updated too...

possibly, i will need to review the pr further to figure out

we can use redirects to either fix a broken historical link eg posted elsewhere, or when we are actually moving a page that has existed

the PR seems to have triggered an upstream flake

/retest

@repokitteh-read-only
Copy link

Retrying Azure Pipelines:
Check envoy-presubmit isn't fully completed, but will still attempt retrying.
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #19018 (comment) was created by @phlax.

see: more, trace.

@phlax
Copy link
Member

phlax commented Nov 16, 2021

docs (will be) rendered here https://storage.googleapis.com/envoy-pr/19018/docs/index.html

@kriswuollett
Copy link
Contributor Author

The only potential explanation for the error I see in the presubmit run is:

intersphinx inventory 'https://www.envoyproxy.io/docs/envoy/v1.17.4/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 400 Client Error: Bad Request for url: https://www.envoyproxy.io/docs/envoy/v1.17.4/objects.inv

Is that what could be the source of the flake?

@phlax
Copy link
Member

phlax commented Nov 16, 2021

Is that what could be the source of the flake?

yep, it is

@phlax
Copy link
Member

phlax commented Nov 17, 2021

/retest

@repokitteh-read-only
Copy link

Retrying Azure Pipelines:
Retried failed jobs in: envoy-presubmit

🐱

Caused by: a #19018 (comment) was created by @phlax.

see: more, trace.

@phlax
Copy link
Member

phlax commented Nov 25, 2021

@kriswuollett looks like this PR needs a main merge

it would be good to fix these links

@kriswuollett
Copy link
Contributor Author

@phlax, sure thing. Will update them now.

@kriswuollett
Merge branch 'main' into fix-http-filter-doc-urls
39e5947
@kriswuollett
doc: Update doc paths to use full public URLs
42fa4df 
The www prefix is not used as it would be removed by a HTTP redirect.

Signed-off-by: Kristopher Wuollett <kristopher.wuollett@gmail.com>
@kriswuollett
Copy link
Contributor Author

I can also update all the other links like in the Markdown files to not have the redirect from the www domain prefix, but wasn't sure how much doc/formatting noise the project is ok with.

phlax
phlax requested changes Nov 29, 2021
View reviewed changes
Copy link
Member

@phlax phlax 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 updating @kriswuollett

there are a few repo links left and then this should be good to land

source/common/formatter/substitution_formatter.h Outdated Show resolved Hide resolved
source/extensions/filters/http/ext_authz/BUILD Show resolved Hide resolved
source/extensions/filters/http/grpc_http1_bridge/http1_bridge_filter.h Outdated Show resolved Hide resolved
source/extensions/filters/http/grpc_web/grpc_web_filter.h Outdated Show resolved Hide resolved
source/extensions/filters/network/ext_authz/BUILD Show resolved Hide resolved
@phlax
Copy link
Member

phlax commented Nov 29, 2021

I can also update all the other links like in the Markdown files ...

lets address that in a separate PR

@kriswuollett kriswuollett force-pushed the fix-http-filter-doc-urls branch 2 times, most recently from 82f495e to db3fd9f Compare December 3, 2021 17:28
@kriswuollett
doc: Use full doc URL in headers
a93cd7e 
Signed-off-by: Kristopher Wuollett <kristopher.wuollett@gmail.com>
@phlax
Copy link
Member

phlax commented Dec 13, 2021

@kriswuollett i think the formatting issues are because you need to merge main

@phlax
Copy link
Member

phlax commented Dec 13, 2021

/wait

phlax
phlax approved these changes Dec 17, 2021
View reviewed changes
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

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

@kriswuollett thanks for taking the time to go through and fix these, lgtm

@phlax phlax merged commit 0a73992 into envoyproxy:main Dec 17, 2021
joshperry pushed a commit to joshperry/envoy that referenced this pull request Feb 13, 2022
@kriswuollett
docs: fix links for public docs (envoyproxy#19018)
d4f1818 
Previously doc paths were not updated within envoyproxy#8027. Resolves envoyproxy#19017.

* doc: Update doc paths to use full public URLs

The www prefix is not used as it would be removed by a HTTP redirect.

Signed-off-by: Kristopher Wuollett <kristopher.wuollett@gmail.com>
Signed-off-by: Josh Perry <josh.perry@mx.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phlax phlax phlax approved these changes

@alyssawilk alyssawilk Awaiting requested review from alyssawilk alyssawilk is a code owner

@asraa asraa Awaiting requested review from asraa

@dio dio Awaiting requested review from dio

@ggreenway ggreenway Awaiting requested review from ggreenway ggreenway is a code owner

@htuch htuch Awaiting requested review from htuch

@junr03 junr03 Awaiting requested review from junr03

@lizan lizan Awaiting requested review from lizan

@mathetake mathetake Awaiting requested review from mathetake

@mattklein123 mattklein123 Awaiting requested review from mattklein123 mattklein123 is a code owner

@rojkov rojkov Awaiting requested review from rojkov

@snowp snowp Awaiting requested review from snowp

@yanavlasov yanavlasov Awaiting requested review from yanavlasov yanavlasov is a code owner

@zuercher zuercher Awaiting requested review from zuercher zuercher is a code owner

Assignees

@phlax phlax

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: links broken for items like http_filters/grpc_json_transcoder_filter
2 participants
@kriswuollett @phlax