Integrate docs into ddev.com
Opened this issue · 5 comments
The unbranded ddev.readthedocs.io is fine, but it would be much better for it to be incorporated into ddev.com.
We can definitely redirect the old into a new spot; that's the easy part.
The harder part is styling and branding the docs into ddev.com. But what a great step it would be for ddev.com/docs (probably equivalent to docs.ddev.com?) were in there.
There are two distinctly different ways of approaching this:
- Continuing to use the Read the Docs / MkDocs platform at a ddev.com address (subdomain or subfolder) and styling it to be more in line with ddev.com.
- Fully incorporating the documentation into the Astro project that powers ddev.com.
I’m not sure what the stylistic constraints are for the Material theme, but that’s just a matter of investigation.
The second would be more comprehensive and offer the most flexibility, at the expense of taking massively more development. Not just for layout and styling, but the need to handle all the things that Material theme accounts for: various components, linting, search, versioning, etc.
I'm thinking option 1, for sure. The fanciest case I can imagine uses mkdocs+mkdocs-material as a subfolder of ddev.com.
I was experimenting yesterday with https://ddev.com/get-started/ and linking each tab to a .md file.
For this, I likely need a new folder that reads docs on the Astro site and move the guide for Mac, Windows, Linux, Cloud under that.
This an example though not a good one.
We will keep the tabs at the top but those will load a markdown file with the steps.
That allows us to use the same settings we use with the blogs with the get started page taking advantage of astro plugins.
Thoughts?
It could be the first step in merging some of the items.
The final proof of concept will look nearly identical to what it looks currently but will live in a markdown file instead of a custom astro component.
This sounds like an interesting initiative, but the point of this issue is to actually put the docs from ddev.readthedocs.io into ddev.com, or at least at docs.ddev.com. You probably want a new issue for the initiative you're talking about here?
Sounds good, I figure maybe this would be a parent to that one. But I will open a new one for it.