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

[DOCS] Add kibana-extra folder to conf.yaml #269

Merged
merged 3 commits into from
Jan 11, 2018
Merged

[DOCS] Add kibana-extra folder to conf.yaml #269

merged 3 commits into from
Jan 11, 2018

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 6, 2017

Adds the kibana-extra folder to the paths in the conf.yaml

@lcawl lcawl added the docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo. label Dec 6, 2017
@lcawl lcawl mentioned this pull request Dec 7, 2017
@kimjoar
Copy link

kimjoar commented Dec 12, 2017

@lcawl We will only be backporting this to 6.x, so maybe we need to use exclude_branches to exclude all earlier versions?

@lcawl
Copy link
Contributor Author

lcawl commented Dec 12, 2017

I think that adding exclude_versions would work for most cases in the conf.yaml, but I'm not sure about what to put for the Kibana Reference's index value:

...
title: Kibana: Explore, Visualize, and Share
sections:
-
title: Kibana Reference
prefix: en/kibana
current: 6.0
branches: [ master, 6.x, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ]
index: ../kibana-extra/x-pack-kibana/docs/en/index.asciidoc
...

@clintongormley If the path to the index.asciidoc is going to differ between 6.1 and later versions (due to addition of "kibana-extra" folder), do I need to split that content into a new book in the conf.yaml?

@lcawl
Copy link
Contributor Author

lcawl commented Dec 12, 2017

@kjbekkelund It looks like in x-pack-elasticsearch the elasticsearch-extra folder was added all the way back to 0.90: https:/elastic/x-pack-elasticsearch/tree/0.90

@clintongormley
Copy link
Contributor

@clintongormley If the path to the index.asciidoc is going to differ between 6.1 and later versions (due to addition of "kibana-extra" folder), do I need to split that content into a new book in the conf.yaml?

Yes, you can't have different paths to index.asciidoc. As suggested above, the alternative is to make the same change back to 0.90

@kimjoar
Copy link

kimjoar commented Dec 13, 2017

@epixa: @lcawl asked me on Slack "Will it be problematic if we add the kibana-extra folder all the way back to 3.0 for docs purposes?" I don't really have an idea about these docs builds, so I'm not sure what effect that has. Do you know what would be okey or not for Kibana?

@epixa
Copy link
Contributor

epixa commented Dec 14, 2017

I'm not an expert at our docs system or anything, but I don't think it's going to be a problem to use kibana-extra for x-pack-kibana all the way back to the 3.0 branch. 6.x introduced the requirement to have x-pack-kibana inside a kibana-extra directory, but it was possible to use that same setup prior to 6.x as well. And even if it weren't possible, the docs system doesn't run Kibana or anything like that, it just needs to know where to find the relevant asciidoc files, so it shouldn't be a problem to have the repo cloned to a different place.

@lcawl
Copy link
Contributor Author

lcawl commented Dec 14, 2017

Great, thanks, @epixa. I've created https:/elastic/x-pack-kibana/pull/3735 and https:/elastic/x-pack/pull/5163 to update the paths.

@kimjoar
Copy link

kimjoar commented Jan 11, 2018

Hm, I wonder if we don't need this change if we revert the change to docs in https:/elastic/x-pack-kibana/pull/4066 (see https:/elastic/x-pack-kibana/pull/4066/commits/80090b9c40ad8e450fd52cddcf107c50ded592fb) (That way we don't make any changes to the docs paths at all).

@kimjoar
Copy link

kimjoar commented Jan 11, 2018

I merged that change, and it seemed to build docs properly. I can create a separate commit to x-pack-kibana that changes the docs path, but as long as docs are working as expected now, it's not something we need to do immediately, I think?

@lcawl lcawl merged commit 714c3fd into elastic:master Jan 11, 2018
@lcawl lcawl deleted the lcawley-extra branch January 11, 2018 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs DO NOT USE for *contents* of our docs. Only use for documentation *about* this repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants