docs: Move files in version-specific dirs

[vikram-dagger]

Signed-off-by: Vikram Vaswani vikram@dagger.io

[vikram-dagger]

Note: This change is internal, end-users should continue to have exactly the same docs experience after merging, with the addition of "contribution guidelines" in the 0.1 docs as stated in #3319 (comment)

[vikram-dagger]

Note: The files in the unspecified directories are not linked in any of the sidebars.

[gerhard]

I'm picking this one up now.

[gerhard]

As I was looking at the three commits, all that I was thinking was https://cbea.ms/git-commit/. That article is so good that we also reference it in our Contributing to Dagger - Commits. We add a few extra details about commits on that page which would have made this PR better.

Closes #3318 commit message could have been:

docs: Move files in version-specific dirs

Before this change, it was difficult to know which version of Dagger a
doc file was for. We had to look at the displayed_sidebar value inside
the doc file to know whether it was for Dagger v0.1.x or v0.2.x. 

After this change, most doc files are now in either v0.1 or v0.2 dirs.

Doc files which are not version specific are stored currently in one of
the following dirs:
- common
- unspecified
- use-cases

For more context, see https://github.com/dagger/dagger/issues/3318

Closes #3318

Merge branch 'main' into 3318-versioning commit could have been a rebase, as we mention in Contributing to Dagger - GitHub Workflow - 3. Update your pull request...

I have 20 mins left from this time-box.

[gerhard]

I was wondering why we moved docs/README.md to docs/_README.md. We now don't see the README by default on the e.g. https://github.com/vikram-dagger/dagger/tree/3318-versioning/docs page.

[gerhard]

In the interest of moving forward, I am keen on getting this merged. Everything that I mentioned can be improved in follow-up PRs.

If the deploy preview looks good to you @crjm @slumbering, please promote it to https://docs.dagger.io/. Everything looks good for me locally:

[vikram-dagger]

I was wondering why we moved docs/README.md to docs/_README.md. We now don't see the README by default on the e.g. https://github.com/vikram-dagger/dagger/tree/3318-versioning/docs page.

Good catch. I'm not entirely sure about this but after some testing, I assumed that Docusaurus considers a README.md file as one of the possible index files in a directory. Therefore, when there is a file called README.md and another document with slug: /, the client generates an error about duplicate route at /. Modifying the README.md file name removes this error.

[crjm]

I was wondering why we moved docs/README.md to docs/_README.md. We now don't see the README by default on the e.g. https://github.com/vikram-dagger/dagger/tree/3318-versioning/docs page.

Good catch. I'm not entirely sure about this but after some testing, I assumed that Docusaurus considers a README.md file as one of the possible index files in a directory. Therefore, when there is a file called README.md and another document with slug: /, the client generates an error about duplicate route at /. Modifying the README.md file name removes this error.

I tried to remove this warning and never could understand why it always showed in the CLI, good one @vikram-dagger !

Everything looks good to me. 🚀

[gerhard]

Thanks for promoting this to https://docs.dagger.io @crjm!

The sidebar fix for 0.1 docs tells me that this went through fine: