Skip to content
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

Integrate docs into ddev.com #49

Open
rfay opened this issue May 1, 2023 · 5 comments
Open

Integrate docs into ddev.com #49

rfay opened this issue May 1, 2023 · 5 comments

Comments

@rfay
Copy link
Member

rfay commented May 1, 2023

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.

@mattstein
Copy link
Collaborator

There are two distinctly different ways of approaching this:

  1. 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.
  2. 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.

@rfay
Copy link
Member Author

rfay commented May 1, 2023

I'm thinking option 1, for sure. The fanciest case I can imagine uses mkdocs+mkdocs-material as a subfolder of ddev.com.

@bmartinez287
Copy link
Collaborator

bmartinez287 commented Oct 28, 2023

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.

Screenshot 2023-10-28 at 2 08 55 PM

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.

@rfay
Copy link
Member Author

rfay commented Oct 28, 2023

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?

@bmartinez287
Copy link
Collaborator

Sounds good, I figure maybe this would be a parent to that one. But I will open a new one for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants