Comments (19)
cc @phlax on ^. I think we have moved away from pushing to envoy-website on every change. I would look at how we do it in Envoy now and model it on that.
from gateway.
I added explicit read access for the assignable team. I think that fixed it. Assigned.
from gateway.
Let's keep our current strategy of using GH Pages to publish EG docs. If anyone disagrees, feel free to reopen.
from gateway.
cc @phlax. I think it would be fine to integrate this into the main site eventually but I would discuss with Ryan. It needs some thinking about flow and placement.
from gateway.
i think we can start building here, and then integrate once we are ready to do so
using sphinx/rst, we can link between docs sites so it should be fairly straightforward to start linking to stuff in the main site and then merge
i guess the first step is getting some ci up and running so that we have something to start dropping docs into
i guess the main question re merging is whether they will (always) be released together - if not it might be better to just host on the envoy website but with a different path - eg /docs/envoy-gateway/latest
etc
from gateway.
@phlax thanks for all the great feedback. I prefer that the gateway project syncs releases with Envoy. I will discuss this with the community and update this issue accordingly.
xref: #15
from gateway.
i guess the main question re merging is whether they will (always) be released together - if not it might be better to just host on the envoy website but with a different path - eg /docs/envoy-gateway/latest etc
Initial feedback during this week's community meeting is that Gateway will not be released with Envoy.
cc: @youngnick @LukeShu
from gateway.
trying to summarize this discussion regarding docs, please correct me if im wrong
- Envoy Gateway will use its own doc publishing pipeline to generate html content.
- This content will be pushed to https://github.com/envoyproxy/envoy-website under
docs/envoy-gateway/<version>
- And will use a CI workflow in Envoy Gateway that raises PRs in https://github.com/envoyproxy/envoy-website every time new doc content is generated
- Envoy Gateway content will be available under a tab similar to https://www.envoyproxy.io/docs
from gateway.
so an explanation of how docs are/were built in Envoy
what we did
- PRs build/test html generation
- commits to
main
- pushed built docs to "latest" on website repo - releases - pushed built docs to version on website repo
the problems
altho very litte changed in the docs from commit to commit - the commit hash did and this led to a diff with 1000s of changes on every main
commit to the repo -> website-repo
over time the website repo became pretty much unusable - it was huge, and cloning/fetching was prone to failing
eventually i stripped out all the hash/main
commits and removed the latest
docs from the repo
what we do now
- PRs - build/test
html
in CI and publish to (gcloud) ci-local storage - commits to
main
- publishrst
to (gcloud) ci-local storage and trigger netlify, which in turns fetches therst
and builds the html from that - release commits - publish built html
this has made the website alot easier to work with
the repo is still pretty large as there are a lot of historical versions, so we are currently looking at the possibility of moving some of these to a separate docs archive repo
from gateway.
thanks for sharing the details @phlax !
so my takeaway is - Envoy Gateway will need a CI workflow similar to what Envoy has
when it wants to publish html content, and should ensure it publishes only during a tagged release / or merge to main( for latest
) to reduce size of the website repo
Also based on #50 it looks like Envoy Gateway will generate its html using Kubebuilder docs .
from gateway.
This issue has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in the next 7 days unless it is tagged "help wanted" or "no stalebot" or other activity occurs. Thank you for your contributions.
from gateway.
This issue has been automatically closed because it has not had activity in the last 37 days. If this issue is still valid, please ping a maintainer and ask them to label it as "help wanted" or "no stalebot". Thank you for your contributions.
from gateway.
I'll take this on, although it seems not possible to assign me right now. 😂
from gateway.
@mattklein123 @phlax @lizan I'm unable to assign @kflynn to the issue. Can someone advise?
from gateway.
Thanks @mattklein123! #203 is a bare-bones first cut here.
from gateway.
xref
from gateway.
Summary of the current state of the world: we're using Sphinx to generate HTML from RST docs, and (for the moment) we're using GitHub Actions to publish said HTML to GitHub Pages (cf https://envoyproxy.github.io/gateway/).
@phlax Shall we just submit an Envoy PR to link out to the GitHub Pages version for now? Otherwise, we still need help getting everything published to GCS and hooked up with the Envoy docs...
from gateway.
i would say lets link it in initially - not sure exactly how/where - but i think that will be easiest
from gateway.
@danehans @kflynn are we keeping this issue open to track eventually linking https://gateway.envoyproxy.io/v0.2.0/ to https://www.envoyproxy.io/docs ?
from gateway.
Related Issues (20)
- Dependencies vulnerability scanning HOT 1
- Add Docker image vulnerabilities scan
- Support Additional External Processing Options
- Create security policy to repo HOT 1
- Support auto host rewrite
- Support multiple backends in TCPRoute HOT 1
- Intermittent 'OAuth Flow Failure' potentially caused by reuse of old connections in pool HOT 7
- docs: provide a suggested path through the docs after the quickstart HOT 3
- docs: make kubectl patch commands use yaml instead of json payloads, for legibility HOT 4
- flaky: TestE2E/RateLimitCIDRMatch/block_all_ips HOT 1
- enhancement: use IfNotPresent for versioned helm chart release HOT 4
- TLS terminated listener + proxy protocol conflict HOT 8
- flaky: TestE2E/GatewayInfraResourceTest/create_gateway HOT 4
- optional client certificate for mutual TLS HOT 4
- gzip compression on /stats/prometheus HOT 1
- e2e test for doc site HOT 3
- egctl x translate should be able to process multiple gatewayclasses
- enhancement: apply `EnvoyGateway` without manually restarting the EG deployment HOT 8
- Merge Gateway Tracing Root Trace service name random HOT 2
- refactor the kubernetes provider to be provider-agnostic
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gateway.