717 - Update config files for k8s #863

alaudazzi · 2019-05-05T15:23:40Z

Needed for #717
Blocked by #32248

Description

Added the k8s alias to the docs/doc_build_aliases.sh
Added the K8s book to the yaml. file

Documentation

User-facing Documentation
Internal Documentation

nrichers

Great PR and it reminds me of the early days of me trying to get the ECE docs to build properly as part of our doc builds. 😁 This needs to build at least one branch that exists in the K8s repo though, so I'll mark this as Request changes for now. Also, does the new build alias work locally?

conf.yaml

doc_build_aliases.sh

conf.yaml

nik9000 · 2019-05-06T14:16:30Z

You should be able to test the conf.yaml change locally with:

./build_docs --all --target_repo [email protected]:elastic/build-docs.git --open

It will take a long, long time. First it has to git fetch about 4GB worth of repos, then it rebuilds all of the books that have changed since the last time they were built by CI. That is usually a few books. Eventually it'll get to your book.... I'm sorry this process is so slow!

nik9000 · 2019-05-06T14:17:23Z

Oh! You'll probably want to use your local checkout of cloud:

./build_docs --all --target_repo [email protected]:elastic/build-docs.git --open --sub_dir cloud:master:../cloud

nrichers · 2019-05-06T15:35:07Z

conf.yaml

+            subject:    k8s
+            current:    2.2
+            branches:   [ ]
+            index:      docs/k8s/index.asciidoc


Note that this PR intends to build the quick start out of the K8s repo, but https://github.com/elastic/cloud/pull/32248 targets the Cloud repo. (https://github.com/elastic/cloud/pull/32248 needs to be replaced by a new PR that targets the K8s repo.)

Done with #781.

nik9000 · 2019-05-08T13:53:05Z

conf.yaml

+            branches:   [ master ]
+            index:      docs/index.asciidoc
+            chunk:      1
+            public:     1


I don't think we need this one.

Could you build it with Asciidoctor with asciidoctor: true? I figure we should try and get all the new things on Asciidoctor.

Where exactly do I need to add asciidoctor: true?

If you replace this line with asciidoctor: true then it'll build with asciidoctor. public: 1 doesn't look like it does anything.

nik9000 · 2019-05-08T13:54:30Z

doc_build_aliases.sh

@@ -67,6 +67,8 @@ alias docbldec='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud/docs/saas/index.

 alias docbldece='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud/docs/cloud-enterprise/index.asciidoc --resource=$GIT_HOME/cloud/docs/shared --chunk 1'

+alias docbldk8s='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud-on-k8s/docs/index.asciidoc --resource $GIT_HOME/cloud/docs/shared --chunk 1'


Could you add --asciidoctor to build it with asciidoctor? I figure we should build all of the new things with Asciidoctor. If it doesn't work I'd be happy to help to get it working.

Where do I need to add --asciidoctor?

If you add it right after build_docs then it'll line up with the other lines in this file. But anywhere in the line is actually fine.

alaudazzi · 2019-05-08T14:06:43Z

I tried to build locally by running this command:
./build_docs --all --target_repo [email protected]:elastic/build-docs.git --open --sub_dir cloud-on-k8s:website-docs:../docs

But it doesn't seem to work:

Ariannas-MacBook-Pro:docs|k8s-book$ ./build_docs --all --target_repo [email protected]:elastic/build-docs.git --open --sub_dir cloud-on-k8s:website-docs:../docs
INFO:docker build:Building the docker image that will build the docs. Expect this to take somewhere between a hundred milliseconds and five minutes.
INFO:build_docs:Waiting for ssh auth to be forwarded to cee56d0ecfaa
INFO:ssh setup:Getting public key to forward to container
INFO:ssh setup:Setting up ssh on container
INFO:ssh setup:Starting OpenBSD Secure Shell server: sshd.
INFO:ssh setup:Forwarding auth socket. IMPORTANT - If this process takes more than a few seconds it has hung and should be manually aborted. I'm very sorry.
INFO:ssh setup:Linux cee56d0ecfaa 4.9.125-linuxkit #1 SMP Fri Sep 7 08:20:28 UTC 2018 x86_64
INFO:ssh setup:
INFO:ssh setup:The programs included with the Debian GNU/Linux system are free software;
INFO:ssh setup:the exact distribution terms for each program are described in the
INFO:ssh setup:individual files in /usr/share/doc/*/copyright.
INFO:ssh setup:
INFO:ssh setup:Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
INFO:ssh setup:permitted by applicable law.
INFO:ssh setup:Done! SSH should work in the container now
INFO:build_docs:Found ssh auth
INFO:build_docs:Updating repositories
INFO:build_docs: - target_repo: Cloning from <[email protected]:elastic/build-docs.git>
INFO:build_docs:Error updating repo <target_repo>: Error executing: git clone --bare [email protected]:elastic/build-docs.git /docs_build/.repos/target_repo.git in GIT_DIR /docs_build/.repos/target_repo.git
INFO:build_docs:
INFO:build_docs:---
INFO:build_docs:Cloning into bare repository '/docs_build/.repos/target_repo.git'...
INFO:build_docs:ERROR: Repository not found.
INFO:build_docs:fatal: Could not read from remote repository.
INFO:build_docs:
INFO:build_docs:Please make sure you have the correct access rights
INFO:build_docs:and the repository exists.
Ariannas-MacBook-Pro:docs|k8s-book$

alaudazzi · 2019-05-08T14:11:30Z

Question for @nrichers and @nik9000:

From which branch do I have to run the command?
I am currently working from two branches:
https://github.com/alaudazzi/cloud-on-k8s/tree/website-docs
and
https://github.com/alaudazzi/docs/tree/k8s-book

lcawl · 2019-05-08T16:48:36Z

@alaudazzi and I chatted and the command in the aliases file works now.
I am also running the command to build all books ($GIT_HOME/docs/build_docs --all --target_repo [email protected]:elastic/built-docs.git --open) and it's in progress (so far so good).

lcawl · 2019-05-08T17:03:18Z

FYI When I build ALL the docs, it returns the following broken links:
INFO:build_docs:Bad cross-document links:
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/k8s/current/k8s-deploy_the_elasticsearch_cluster.html:
INFO:build_docs: - en/elasticsearch/reference/7.0getting-started.html
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/k8s/current/k8s-deploy_the_kibana_instance.html:
INFO:build_docs: - en/kibana/7.0introduction.html
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/k8s/master/k8s-deploy_the_elasticsearch_cluster.html:
INFO:build_docs: - en/elasticsearch/reference/7.0getting-started.html
INFO:build_docs: /tmp/docsbuild/target_repo/html/en/k8s/master/k8s-deploy_the_kibana_instance.html:
INFO:build_docs: - en/kibana/7.0introduction.html

I've created a PR to fix those broken links.

lcawl

LGTM and builds successfully. Broken links are all resolved now.

alaudazzi · 2019-05-08T18:37:55Z

A big THANK YOU to all of you for the great support you provided!

pebrc · 2019-05-19T16:43:06Z

conf.yaml

@@ -525,6 +526,21 @@ contents:
                path:   docs/shared
                exclude_branches: [ 1.0 ]

+         -
+            title:      Elastic Cloud on Kubernetes
+            prefix:     en/k8s


Can we make this prefix match the repo name? cloud-on-k8s

Changed the prefix from k8s to cloud-on-kubernetes as per pbrc request

changed the prefix into "cloud-on-k8s"

* 717 - Update config files for k8s * Integrate nrichers comments * Update doc build script * Rectified path to index.asciidoc * Adds URL for cloud-on-k8s * Update config files to get one single page * Update conf.yaml * Update conf.yaml * Update conf.yaml * Update conf.yaml * Update conf.yaml Changed the prefix from k8s to cloud-on-kubernetes as per pbrc request * Update conf.yaml changed the prefix into "cloud-on-k8s"

717 - Update config files for k8s

86db2fd

alaudazzi added docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. WIP labels May 5, 2019

alaudazzi requested review from nrichers, kellyemurphy and KOTungseth May 5, 2019 15:23

alaudazzi self-assigned this May 5, 2019

nrichers suggested changes May 6, 2019

View reviewed changes

conf.yaml Outdated Show resolved Hide resolved

conf.yaml Outdated Show resolved Hide resolved

doc_build_aliases.sh Outdated Show resolved Hide resolved

conf.yaml Outdated Show resolved Hide resolved

nrichers reviewed May 6, 2019

View reviewed changes

conf.yaml Outdated Show resolved Hide resolved

Merge branch 'master' of github.com:elastic/docs into k8s-book

d0d834f

nrichers reviewed May 6, 2019

View reviewed changes

alaudazzi added 3 commits May 8, 2019 10:14

Integrate nrichers comments

2188df7

Update doc build script

293c71e

Rectified path to index.asciidoc

29d0072

nik9000 reviewed May 8, 2019

View reviewed changes

lcawl mentioned this pull request May 8, 2019

[DOCS] Adds partintro elastic/cloud-on-k8s#787

Merged

Adds URL for cloud-on-k8s

17d2675

lcawl mentioned this pull request May 8, 2019

[DOCS] Fix broken links elastic/cloud-on-k8s#788

Merged

lcawl self-requested a review May 8, 2019 17:44

lcawl approved these changes May 8, 2019

View reviewed changes

alaudazzi added 3 commits May 9, 2019 15:26

Merge branch 'master' into k8s-book

4c4375b

Merge branch 'k8s-book' of github.com:alaudazzi/docs into k8s-book

9a7e8dc

Update config files to get one single page

323dff6

alaudazzi added 4 commits May 16, 2019 13:43

Update conf.yaml

5e8dece

Update conf.yaml

6450c5f

Update conf.yaml

bd5d26c

Update conf.yaml

c844b0a

pebrc reviewed May 19, 2019

View reviewed changes

alaudazzi added 2 commits May 20, 2019 07:33

Update conf.yaml

79f375c

Changed the prefix from k8s to cloud-on-kubernetes as per pbrc request

Update conf.yaml

aea21cf

changed the prefix into "cloud-on-k8s"

alaudazzi merged commit 000d3da into elastic:master May 20, 2019

		@@ -67,6 +67,8 @@ alias docbldec='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud/docs/saas/index.

		alias docbldece='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud/docs/cloud-enterprise/index.asciidoc --resource=$GIT_HOME/cloud/docs/shared --chunk 1'

		alias docbldk8s='$GIT_HOME/docs/build_docs --doc $GIT_HOME/cloud-on-k8s/docs/index.asciidoc --resource $GIT_HOME/cloud/docs/shared --chunk 1'

717 - Update config files for k8s #863

717 - Update config files for k8s #863

Uh oh!

Conversation

alaudazzi commented May 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Documentation

Uh oh!

nrichers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nik9000 commented May 6, 2019

Uh oh!

nik9000 commented May 6, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alaudazzi commented May 8, 2019

Uh oh!

alaudazzi commented May 8, 2019

Uh oh!

lcawl commented May 8, 2019

Uh oh!

lcawl commented May 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lcawl left a comment

Choose a reason for hiding this comment

Uh oh!

alaudazzi commented May 8, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alaudazzi commented May 5, 2019 •

edited

Loading

lcawl commented May 8, 2019 •

edited

Loading