Update Gitbook release process #659

davidewatson · 2018-12-21T16:55:03Z

What this PR does / why we need it:

The current Gitbook release process is not reproducible. Some node modules fail to install cleanly on all developer machines, and not all developers have access to git subtree. This is the first step in making the process reproducible so that we can add CI pre and post-submit jobs.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

Related to #655

davidewatson · 2018-12-21T16:55:15Z

/hold

neolit123

@davidewatson thanks, added some minor comments.

docs/book/RELEASE

neolit123 · 2019-01-12T16:37:03Z

docs/book/RELEASE

+
+cd docs/book
+gitbook serve
+open localhost:4000


is open portable?

Interesting question. On MacOS, man open says:

HISTORY
First appeared in NextStep.

On Linux open is actually openvt and is provided by the kbd project. According to it's man page the command has existed since:

19 Jul 1996 V1.4 OPENVT(1)

So while it is not POSIX, it's been around a long time. Do you think it would suffice if I added a comment explaining how to get the open command if it is not already installed on your system (I believe it is installed by default on MacOS...)?

Alternatively, the command could be replaced or augmented with a comment explaining the intent, per #659 (comment)

i think a comment would be easier - e.g.
# open localhost:4000 in a browser

neolit123

/lgtm
thanks for the update @davidewatson !
do we need the hold on this still?

neolit123 · 2019-02-13T00:47:54Z

/assign @vincepri

davidewatson · 2019-02-13T16:10:30Z

@neolit123: Let's discuss this today. It can be merged as is but there is still a gap in the deployment of GitBook changes. Ideally, we would like to merge changes into the gh-pages branch so that they can be served by GitHub. However, I am having difficulty making this work properly without losing history. Unless someone else has an idea of how to fix this I am inclined to keep all of the source within the master branch and then using firebase to host.

neolit123 · 2019-02-14T16:18:39Z

xref kubernetes/k8s.io#189

detiber

I don't currently see anything netlify-specific in the configs here? Is that all done on the Netlify side?

docs/book/package.json

davidewatson · 2019-03-19T20:58:25Z

The process for this is still being worked out. The tracking ticket is kubernetes/community#3454 and we hope to have a resolution within a week or two.

always install cleanly.

instead.

k8s-ci-robot · 2019-06-03T19:30:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: davidewatson

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [davidewatson]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

the GitHub repository.

for the correct location...

detiber

Minor comment around the netlify config and the related DNS changes, otherwise lgtm

netlify.toml

been created.

davidewatson · 2019-06-03T20:55:27Z

Okay, here is the current result: https://kubernetes-sigs-cluster-api.netlify.com/

Now I will work on securing the cluster-api.sigs.k8s.io domain...

vincepri · 2019-06-04T00:43:17Z

Amazing work @davidewatson !

detiber · 2019-06-04T15:11:57Z

yay!

/lgtm

vincepri · 2019-06-04T20:25:57Z

@davidewatson Feel free to remove the hold when ready!

domain exists.

davidewatson · 2019-06-04T21:02:18Z

/hold cancel
/lgtm

k8s-ci-robot · 2019-06-04T21:02:19Z

@davidewatson: you cannot LGTM your own PR.

In response to this:

/hold cancel
/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

detiber · 2019-06-04T21:04:57Z

/lgtm

* Remove mermaid module because it is currently unused and does not always install cleanly. * Introduce npm-shrinkwrap so that npm installations are reproducable. * Update gitbook release documentation. * Clarify verification instructions. * Update GitBook. * Remove rendered Gitbook from repo in preparation for using firebase instead. * Install gitbook cli. * Update documentation for netlify. * Add Netlify configuration toml. * Update link to homepage so that it points to the book and not the GitHub repository. * Remove base from netlify.toml. The build script already accounts for the correct location... * Remove reference to no longer existent KEP. :( * Disable redirects until the cluster-api.sigs.k8s.io domain has been created. * Reenable netlify redirects now that the cluster-api.sigs.k8s.io domain exists.

* Adding steps for how to use existing cluster as bootstrap cluster. (#877) * Add proposals template (#879) Signed-off-by: Vince Prignano <[email protected]> * Clarify how to use kuebconfig. (#869) * Add discuss link to README (#885) Signed-off-by: Vince Prignano <[email protected]> * Fix a broken link to Cluster API KEP (#900) * Add Cluster API project scope and objectives (#882) Signed-off-by: Vince Prignano <[email protected]> * Fix API group name written in kubebuilder's annotation comments (#883) * Update github org for the baremetal provider. (#911) The github org was renamed, so use the new URL for the location of the bare metal cluster-api provider. * Add Talos to list of providers (#915) * Add reference use cases for Cluster API (#903) Signed-off-by: Vince Prignano <[email protected]> * Add missing bullet point to staging-use-cases.md (#920) * Added IBM Cloud to Cluster API README. (#928) * Update documentation links to published content (#927) * Add Cluster API logos from CNCF (#916) * Adding Reference Use Cases to README. (#931) * Updating release docs for branching approach now that we are 0.x (#862) I think the previous approach was for pre-versioned branches, but now we probably want to start maintaining release branches - even if in practice we would cut 0.2.0 instead of 0.1.1 * Used doctoc generated toc. (#932) * Update to go 1.12.5 (#937) * Attempt to fix integration tests (#942) - Use specific versions of kind and kustomize instead of installing with `go get` - Update golang version for example provider * Update README.md (#941) * Add shortnames for crds. (#943) * Fix machine object pivoting to the target cluster (#944) * [docs] Update RBAC annotations for example provider (#947) * Remove workstreams from scope and objectives (#948) Signed-off-by: Vince Prignano <[email protected]> * Added ibm cloud to architecture diagram. (#946) * Added comment about cluster API vs cloud providers to readme (#954) * Quit MachineSet reconcile early if DeletionTimestamp is set (#956) Signed-off-by: Vince Prignano <[email protected]> * Cleanup controllers (#958) Signed-off-by: Vince Prignano <[email protected]> * updates Google Cloud branding to mach other usages (#973) * Cannot retrieve machine name (#960) Signed-off-by: clyang82 <[email protected]> * Allow to use foregroundDeletion for MachineDeployments and MachineSets (#953) * Rename controllers test files (#968) Signed-off-by: Vince Prignano <[email protected]> * make cluster-api-manager container run with a non-root user (#955) * Update Gitbook release process (#659) * Remove mermaid module because it is currently unused and does not always install cleanly. * Introduce npm-shrinkwrap so that npm installations are reproducable. * Update gitbook release documentation. * Clarify verification instructions. * Update GitBook. * Remove rendered Gitbook from repo in preparation for using firebase instead. * Install gitbook cli. * Update documentation for netlify. * Add Netlify configuration toml. * Update link to homepage so that it points to the book and not the GitHub repository. * Remove base from netlify.toml. The build script already accounts for the correct location... * Remove reference to no longer existent KEP. :( * Disable redirects until the cluster-api.sigs.k8s.io domain has been created. * Reenable netlify redirects now that the cluster-api.sigs.k8s.io domain exists. * Add versioning and releases to README (#967) Signed-off-by: Vince Prignano <[email protected]> * Add more log for cluster deletion failure (#978) * Update dependencies (#982) Signed-off-by: Vince Prignano <[email protected]>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 21, 2018

k8s-ci-robot requested review from krisnova and krousey December 21, 2018 16:55

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 21, 2018

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 21, 2018

neolit123 reviewed Jan 12, 2019

View reviewed changes

davidewatson mentioned this pull request Feb 6, 2019

Stronger link between Machine* <-> Cluster #728

Merged

k8s-ci-robot assigned neolit123 Feb 13, 2019

neolit123 approved these changes Feb 13, 2019

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 13, 2019

k8s-ci-robot assigned vincepri Feb 13, 2019

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 13, 2019

detiber reviewed Feb 21, 2019

View reviewed changes

docs/book/package.json Outdated Show resolved Hide resolved

davidewatson mentioned this pull request Mar 27, 2019

Fix broken links to kubebuilder book #858

Closed

davidewatson added 9 commits June 3, 2019 11:56

Remove mermaid module because it is currently unused and does not

ad92042

always install cleanly.

Update gitbook release documentation.

14ce7c3

Introduce npm-shrinkwrap so that npm installations are reproducable.

4fb1252

Clarify verification instructions.

e2406af

Update GitBook.

913b02f

Remove rendered Gitbook from repo in preparation for using firebase

a23a57d

instead.

Install gitbook cli.

378a7be

Update documentation for netlify.

c9584d8

Add Netlify configuration toml.

e255ca6

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 3, 2019

davidewatson added 3 commits June 3, 2019 13:17

Update link to homepage so that it points to the book and not

8b94095

the GitHub repository.

Remove base from netlify.toml. The build script already accounts

b487612

for the correct location...

Remove reference to no longer existent KEP. :(

3a1af13

detiber reviewed Jun 3, 2019

View reviewed changes

netlify.toml Show resolved Hide resolved

Disable redirects until the cluster-api.sigs.k8s.io domain has

fa4b216

been created.

k8s-ci-robot assigned detiber Jun 4, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 4, 2019

davidewatson mentioned this pull request Jun 4, 2019

Create cluster-api.sigs.k8s.io to publish documentation with Netlify kubernetes/k8s.io#267

Merged

Reenable netlify redirects now that the cluster-api.sigs.k8s.io

dbb4338

domain exists.

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 4, 2019

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 4, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 4, 2019

k8s-ci-robot merged commit 5459307 into kubernetes-sigs:master Jun 4, 2019

davidewatson deleted the gitbook-releases branch June 5, 2019 05:29

davidewatson mentioned this pull request Jun 11, 2019

Update GitBook URL to point to netlify served pages instead of #1013

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Gitbook release process #659

Update Gitbook release process #659

davidewatson commented Dec 21, 2018

davidewatson commented Dec 21, 2018

neolit123 left a comment

neolit123 Jan 12, 2019

davidewatson Jan 13, 2019 •

edited

Loading

neolit123 Jan 13, 2019

neolit123 left a comment

neolit123 commented Feb 13, 2019

davidewatson commented Feb 13, 2019

neolit123 commented Feb 14, 2019

detiber left a comment

davidewatson commented Mar 19, 2019

k8s-ci-robot commented Jun 3, 2019

detiber left a comment

davidewatson commented Jun 3, 2019

vincepri commented Jun 4, 2019

detiber commented Jun 4, 2019

vincepri commented Jun 4, 2019

davidewatson commented Jun 4, 2019

k8s-ci-robot commented Jun 4, 2019

detiber commented Jun 4, 2019

Update Gitbook release process #659

Update Gitbook release process #659

Conversation

davidewatson commented Dec 21, 2018

davidewatson commented Dec 21, 2018

neolit123 left a comment

Choose a reason for hiding this comment

neolit123 Jan 12, 2019

Choose a reason for hiding this comment

davidewatson Jan 13, 2019 • edited Loading

Choose a reason for hiding this comment

neolit123 Jan 13, 2019

Choose a reason for hiding this comment

neolit123 left a comment

Choose a reason for hiding this comment

neolit123 commented Feb 13, 2019

davidewatson commented Feb 13, 2019

neolit123 commented Feb 14, 2019

detiber left a comment

Choose a reason for hiding this comment

davidewatson commented Mar 19, 2019

k8s-ci-robot commented Jun 3, 2019

detiber left a comment

Choose a reason for hiding this comment

davidewatson commented Jun 3, 2019

vincepri commented Jun 4, 2019

detiber commented Jun 4, 2019

vincepri commented Jun 4, 2019

davidewatson commented Jun 4, 2019

k8s-ci-robot commented Jun 4, 2019

detiber commented Jun 4, 2019

davidewatson Jan 13, 2019 •

edited

Loading