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.

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

Adds eland-docs repo to conf.yaml and alias to doc_build_aliases.sh #1772

Merged
merged 4 commits into from Mar 16, 2020

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 12, 2020

This PR adds a new repository (eland-docs) to the conf.yaml file and a build alias to the doc_build_alias.sh file.

Depends on elastic/elasticsearch-eland-docs#4. Please merge that PR first

@szabosteve szabosteve changed the title Adds eland-docs repo to conf.yaml Adds eland-docs repo to conf.yaml and doc build alias Mar 12, 2020
@szabosteve szabosteve changed the title Adds eland-docs repo to conf.yaml and doc build alias Adds eland-docs repo to conf.yaml and alias to doc_build_aliases.sh Mar 12, 2020
@lcawl
Copy link
Contributor

lcawl commented Mar 12, 2020

I created elastic/elasticsearch-eland-docs#4 to fix the resolution of the shared attributes. Please merge that PR before you merge this one.

I also added the "single: 1" option to the conf.yaml and the "--single" option to the build alias in this PR, since that makes it a single page to match what's done for other clients.

@szabosteve
Copy link
Contributor Author

@elasticmachine test this please

@lcawl
Copy link
Contributor

lcawl commented Mar 13, 2020

@elasticmachine run elasticsearch-ci/docs rebuild

@lcawl
Copy link
Contributor

lcawl commented Mar 13, 2020

I can replicate this build error on my local machine, by running the ./docs/build_docs --all --target_repo git@github.m:elastic/built-docs.git --open command:

09:49:36 INFO:build_docs: - eland Client: Building master...
09:49:36 INFO:build_docs: - eland Client: Building 7.x...
09:49:36 INFO:build_docs: - eland Client: Finished master
09:49:36 INFO:build_docs: - eland Client: Finished 7.x
09:49:36 INFO:build_docs:couldn't update version at lib/ES/Book.pm line 383.

The error goes away and the docs build is successful if I (A) remove either master or 7.x from the list of branches, or (B) remove the "single: 1" option.

@nik9000 This seems like a bug to me, since --single is defined as "Generate a single HTML page, instead of a chunking into a file per chapter" but that shouldn't mean that you can have multiple branches of that single page.

@szabosteve
Copy link
Contributor Author

@lcawl @nik9000
In the meantime, I removed master from the list of branches as the valid documentation will be in 7.x anyway. I won't merge this until Nik can have a look.
Thanks to both of you!

@nik9000
Copy link
Member

nik9000 commented Mar 16, 2020

I've reproduced the issue locally and will fix it. I'm not sure what is causing it yet, but I'll fix it!

@nik9000
Copy link
Member

nik9000 commented Mar 16, 2020

I also added the "single: 1" option to the conf.yaml and the "--single" option to the build alias in this PR, since that makes it a single page to match what's done for other clients.

I believe the bug that we have is that single page books can't have more than one version. I'm not sure why that is, but eland would be the first book that does.

For what it is worth lots of our clients use standard chunking: Java, PHP, Javascript, .NET, Ruby. The ones that just link off to their "native" docs like python and perl do not. I'm not sure what eland plans to do.

@szabosteve szabosteve merged commit 90b5fe2 into elastic:master Mar 16, 2020
@szabosteve szabosteve deleted the eland.docs branch March 16, 2020 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants