Add support for extensionless URLs (pretty URLs)

[reakaleek]

Details

This will add support for extensionless URLs.

serve command

E.g http://localhost:5000/migration/syntax.html becomes http://localhost:5000/migration/syntax

However, using .html extensions still works for backward compatibility.

generate command

In the generate command, we change the file and folder structure to always have an index.html file for every page.

e.e /migration/syntax.html becomes /migration/syntax/index.html.

This way, we can strip the /index.html segment from the URL and still serve the correct file.

an example of this is deployed at https://dwnz7p9ulv07a.cloudfront.net/migration/versioning

[Mpdreamz]

In the generate command, we change the file and folder structure to always have an index.html file for every page.

e.e /migration/syntax.html becomes /migration/syntax/index.html.

I am not sure this aids in keeping the docs simple for new contributors.
We kind of lose that 1:1 mapping of URL to file: turning /migration/syntax.md to /migration/syntax/index.html

Don't really have a full fledged opinion on this (yet) though need to mull it over a bit ⌛

[reakaleek]

In the generate command, we change the file and folder structure to always have an index.html file for every page.

e.e /migration/syntax.html becomes /migration/syntax/index.html.

I am not sure this aids in keeping the docs simple for new contributors. We kind of lose that 1:1 mapping of URL to file: turning /migration/syntax.md to /migration/syntax/index.html

Don't really have a full fledged opinion on this (yet) though need to mull it over a bit ⌛

Just to give some context: I was actually highly inspired by https://middlemanapp.com/advanced/pretty-urls/

generally, IMHO this is just the representation on the server. I assume developers or authors will not check the files on production and check if there is a 1-to-1 mapping.

technically, I need to do this to simplify the the cloudfront lambda function and being able to just append /index.html to the origin request.

[bmorelli25]

Related to https://github.com/elastic/docs-projects/issues/329
cc @KOTungseth

[Mpdreamz]

This LGTM for the most part!

I think we should make MarkdownFile as the index property through an IsIndex prop on the class.

We now have quite a few places where we handle index.md specially through a magic string however

- folder: mover
  children:
    - file: first-page.md
    - file: second-page.md

Here first-page.md is the index file for the mover folder.

[Mpdreamz]

LGTM, we can address my feedback in a follow up PR.

[reakaleek]

This LGTM for the most part!

I think we should make MarkdownFile as the index property through an IsIndex prop on the class.

We now have quite a few places where we handle index.md specially through a magic string however

- folder: mover
  children:
    - file: first-page.md
    - file: second-page.md

Here first-page.md is the index file for the mover folder.

Could you elaborate on this?

I tried to understand this statement.

but it looks like this works here https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/274/testing/mover/first-page/, if I compare it to the behaviour of https://elastic.github.io/docs-builder/testing/mover/first-page.html

[reakaleek]

This should wait for #442 before being merged.