Start using index.md instead of README.md in our docs

We are going forward deprecating the /help page in the future (https://gitlab.com/gitlab-org/gitlab-ce/issues/18739), so that we can focus on https://docs.gitlab.com.

Proposal

Since the docs portal will be our main concern, I propose to start using index.md files instead of README.md for cases where we want for this file to act like an introduction document for all the others in the same directory.

Related issues

Also see the related feature proposal issue: Make index.md render like README.md when it's present in a repository.

---

cc @rspeicher @dblessing @SeanPackham @sytses @markpundsack @marcia

I agree :)

Mentioned in merge request !7142 (merged)

So to be clear, this is specifically about starting to use index.md in preparation for when the app supports the option of displaying an index.md file or a readme.md file, correct? I think that's reasonable and the flexibility doesn't hurt "the old flow"

@lbot Correct, although I don't know when/if the proposal in https://gitlab.com/gitlab-org/gitlab-ce/issues/18933 will be implemented :)

The primary reason is to not have links that end in README.html like https://docs.gitlab.com/ce/gitlab-basics/README.html

closed