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

[proposal] move _all_ examples from GitHub to netlify #1619

Closed
davecheney opened this issue Oct 3, 2019 · 5 comments · Fixed by #1757
Closed

[proposal] move _all_ examples from GitHub to netlify #1619

davecheney opened this issue Oct 3, 2019 · 5 comments · Fixed by #1757
Assignees
@davecheney
Labels
priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone
1.0.0

Comments

@davecheney
Copy link
Contributor

A perennial problem for users who start with GitHub rather than projectcontour.io is they are using our :master branch. This means they can get a broken or unstable expirience, eg. #1615

This sort of go worse when we move the README from recommending :master to the :latest release, moving the Quickstart yaml further from the experience of git pull && kubectl apply. #1484

Some possible solutions I can think of:

  1. Switch the default branch in git from master to release-whatever, this should mean the quickstart and the documentation in GitHub match up. With the write kind of url hacking this could remove the requirement to update site/_redirects on each release. The downside of this is it'll probably screw up every single PR pushed to the site because GitHub will base the PR on the release branch, not the master branch.
  2. We move the Quickstart documentation to netlify and remove it from the README. The readme makes it clear that this is the development version and to go to projectcontour.io/quickstart for the stable version.
  3. Probably in combination with 2 we move all the examples from GitHub to netlify -- move them into the site/examples directory. This would mean changing netlify to pull from the latest release branch, not master so the example changes are not updated until we cut a release.
@davecheney davecheney added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Oct 3, 2019
@davecheney davecheney added this to the 1.0.0-rc.2 milestone Oct 3, 2019
@stevesloka
Copy link
Member

I'd like to see about moving more to netlify for all the docs, having everything versioned in there should fix the problem. I'd expect the master version to point to latest and all others would be tagged in the proper release.

@davecheney
Copy link
Contributor Author

I'd be down with that. Now I understand how to do redirects doing a projectcontour.io/docs/latest shouldn't be too difficult.

@jonasrosland
Copy link
Contributor

I think this would be a great move, showing users the examples front and center. Removing confusion = always 👍

I agree with Steve as well, having versioned docs would be nice to have, it does require some minor rework of the current docs structure though.

Your solution Dave to only build the website based on the latest release should also work nicely, I think it would require a few manual steps for each release (point to the right branch in Netlify and run a manual build after release). That's a quick thing though, and we can most likely trigger something using webhooks though, to hopefully remove those manual steps.

@stevesloka stevesloka mentioned this issue Oct 7, 2019
Closed
@youngnick
Copy link
Member

youngnick commented Oct 7, 2019 •
edited
Loading

I very much like the idea of versioned docs, and in my mind the docs include the examples.

@davecheney davecheney self-assigned this Oct 13, 2019
davecheney added a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney
site: move getting-started documentation to website
67bcdf1 
Updates projectcontour#1619

Migrate the getting started section of the README to
projectcontour.io/getting-started.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney
site: move getting-started documentation to website
e68990d 
Updates projectcontour#1619

Migrate the getting started section of the README to
projectcontour.io/getting-started.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney
site: move getting-started documentation to website
140a1b2 
Updates projectcontour#1619

Migrate the getting started section of the README to
projectcontour.io/getting-started.

Signed-off-by: Dave Cheney <[email protected]>
@davecheney davecheney mentioned this issue Oct 14, 2019
Merged
davecheney added a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney
site: move non versioned docs to projectcontour.io/resources
4e21f58 
Updates projectcontour#1619

Take a first pass through the /docs/ directory any move any documents
which are not specific to a release. Also remove a few outdated docs
like tls.md and zenhub.md.

Signed-off-by: Dave Cheney <[email protected]>
@davecheney davecheney mentioned this issue Oct 14, 2019
Merged
stevesloka pushed a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney @stevesloka
site: move getting-started documentation to website
82f3dc7 
Updates projectcontour#1619

Migrate the getting started section of the README to
projectcontour.io/getting-started.

Signed-off-by: Dave Cheney <[email protected]>
stevesloka pushed a commit that referenced this issue Oct 14, 2019
@davecheney @stevesloka
site: move getting-started documentation to website
49bc3f2 
Updates #1619

Migrate the getting started section of the README to
projectcontour.io/getting-started.

Signed-off-by: Dave Cheney <[email protected]>
stevesloka pushed a commit to davecheney/contour that referenced this issue Oct 14, 2019
@davecheney @stevesloka
site: move non versioned docs to projectcontour.io/resources
6ddaf65 
Updates projectcontour#1619

Take a first pass through the /docs/ directory any move any documents
which are not specific to a release. Also remove a few outdated docs
like tls.md and zenhub.md.

Signed-off-by: Dave Cheney <[email protected]>
stevesloka pushed a commit that referenced this issue Oct 14, 2019
@davecheney @stevesloka
site: move non versioned docs to projectcontour.io/resources
921421c 
Updates #1619

Take a first pass through the /docs/ directory any move any documents
which are not specific to a release. Also remove a few outdated docs
like tls.md and zenhub.md.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 18, 2019
@davecheney
site: move the remainder of /docs to /site
9da67ce 
Updates projectcontour#1619

Signed-off-by: Dave Cheney <[email protected]>
@davecheney davecheney mentioned this issue Oct 18, 2019
Merged
davecheney added a commit to davecheney/contour that referenced this issue Oct 18, 2019
@davecheney
site: move the remainder of /docs to /site
6583e10 
Updates projectcontour#1619

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 18, 2019
@davecheney
site: move the remainder of /docs to /site
2bf9023 
Updates projectcontour#1619

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 18, 2019
@davecheney
site: move the remainder of /docs to /site
2c1cb85 
Updates projectcontour#1619

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit that referenced this issue Oct 18, 2019
@davecheney
site: move the remainder of /docs to /site
604df27 
Updates #1619

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 21, 2019
@davecheney
site: enable strict mode
2b9d79f 
Updates projectcontour#1619

Enables strict mode and fix strict mode failures.

Signed-off-by: Dave Cheney <[email protected]>
@davecheney davecheney mentioned this issue Oct 21, 2019
Merged
@davecheney davecheney modified the milestones: 1.0.0-rc.2, 1.0.0 Oct 22, 2019
davecheney added a commit to davecheney/contour that referenced this issue Oct 22, 2019
@davecheney
site: point to latest github release tag where possible
7d262e8 
Fixes projectcontour#1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
@davecheney
Copy link
Contributor Author

Moving to 1.0 final because of the circular dependency on a latest release version > 0.15.x

@davecheney davecheney mentioned this issue Oct 22, 2019
Merged
davecheney added a commit to davecheney/contour that referenced this issue Oct 22, 2019
@davecheney
site: enable strict mode
d0dfe9c 
Updates projectcontour#1619

Enables strict mode and fix strict mode failures.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit that referenced this issue Oct 22, 2019
@davecheney
site: enable strict mode
f122601 
Updates #1619

Enables strict mode and fix strict mode failures.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Oct 22, 2019
@davecheney
site: point to latest github release tag where possible
36e29c8 
Fixes projectcontour#1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Nov 1, 2019
@davecheney
site: point to latest github release tag where possible
2767bce 
Fixes projectcontour#1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Nov 1, 2019
@davecheney
site: point to latest github release tag where possible
b83c2ff 
Fixes projectcontour#1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit to davecheney/contour that referenced this issue Nov 1, 2019
@davecheney
site: point to latest github release tag where possible
5e430d4 
Fixes projectcontour#1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
davecheney added a commit that referenced this issue Nov 1, 2019
@davecheney
site: point to latest github release tag where possible
a85a6ff 
Fixes #1619

For 1.0 the plan of record is to keep the examples on GitHub. This is
due to the difficulty in doing directory index style static resources
from projectcontour.io.

To support this weave the name of the current github release through the
website.

Note that at the present, in the rc.2 timeframe, this will break a lot
of links so this PR is targeted for 1.0 (or shortly after) which will
bring the guides, resources, and release documentation in line with the
latest released tag on GitHub.

Signed-off-by: Dave Cheney <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@davecheney davecheney

Labels
priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

site: point to latest github release tag where possible davecheney/contour
4 participants
@davecheney @stevesloka @jonasrosland @youngnick