Skip to content

[DOCS] Add index-extra-title-page.html for direct HTML migration #50189

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

Merged
merged 1 commit into from
Dec 13, 2019
Merged

[DOCS] Add index-extra-title-page.html for direct HTML migration #50189

merged 1 commit into from
Dec 13, 2019

Conversation

jrodewig
Copy link
Contributor

Adds the index-extra-title-page.html file, which will replace index-docinfo.xml and index.x-docinfo.xml once we migrate our docs build to direct HTML.

This file contains the following introductory text for the ES Reference index:
Screen Shot 2019-12-13 at 10 25 11 AM

The file is inert until the direct HTML migration happens. Even then, this change is no-op.

@jrodewig jrodewig added >docs General docs changes :Docs labels Dec 13, 2019
@jrodewig jrodewig requested a review from nik9000 December 13, 2019 15:28
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@nik9000
Copy link
Member

nik9000 commented Dec 13, 2019

I think it needs to be index-x-titlepage or it won't render!

@jrodewig
Copy link
Contributor Author

@nik9000 I tested this locally with --direct-html and the current file name and it appears to render. Not sure how to stage a --direct-html preview, but here's a screenshot:
Screen Shot 2019-12-13 at 11 57 01 AM

You can tell it's the direct HTML version because it's missing the auto-generated anchors from the docbook version:

Screen Shot 2019-12-13 at 11 58 40 AM

Just to see, I did try changing the file to index-x-titlepage locally, but that appears to break it:
Screen Shot 2019-12-13 at 12 05 20 PM

@nik9000
Copy link
Member

nik9000 commented Dec 13, 2019

I think the trick is that in conf.yaml we say we use index.x.asciidoc so you have to do that too to test these.

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this @jrodewig !

@jrodewig
Copy link
Contributor Author

@nik9000 I attempted renaming this to index.x-extra-title-page.html and it doesn't render.

I believe this line in Util.pm may be stripping out the .x:
https://github.com/elastic/docs/blob/master/lib/ES/Util.pm#L376

    my $extra_title_page = $index->basename;

My guess is that it thinks .x.asciidoc is the extension. Haven't confirmed that though.

@nik9000
Copy link
Member

nik9000 commented Dec 13, 2019

Ah! Well, let's merge it and give it a go!

@nik9000
Copy link
Member

nik9000 commented Dec 13, 2019

My guess is that it thinks .x.asciidoc is the extension. Haven't confirmed that though.

That'd be really good actually.

@jrodewig jrodewig merged commit 6749b63 into elastic:master Dec 13, 2019
@jrodewig jrodewig deleted the add-extra-title-page branch December 13, 2019 17:44
jrodewig added a commit that referenced this pull request Dec 13, 2019
jrodewig added a commit that referenced this pull request Dec 13, 2019
jrodewig added a commit that referenced this pull request Dec 13, 2019
jrodewig added a commit that referenced this pull request Dec 13, 2019
jrodewig added a commit that referenced this pull request Jan 6, 2020
This change is no-op.

The `index-docinfo.xml` and `index.x-docinfo.xml` were replaced by the
`index-extra-title-page.html` file in #50189.

Now that our documentation is built using direct HTML rather than
docbook, these XML files are no longer used.
SivagurunathanV pushed a commit to SivagurunathanV/elasticsearch that referenced this pull request Jan 23, 2020
SivagurunathanV pushed a commit to SivagurunathanV/elasticsearch that referenced this pull request Jan 23, 2020
This change is no-op.

The `index-docinfo.xml` and `index.x-docinfo.xml` were replaced by the
`index-extra-title-page.html` file in elastic#50189.

Now that our documentation is built using direct HTML rather than
docbook, these XML files are no longer used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants