Add "how to deploy in production" to the install docs

[gene1wood]

Feature Request

Currently the README.md starts out with "Why use Docs?" which is good, followed by "Getting Started"

The "Getting Started" section contains two sub headings, "Test it" showing how to try out a demo site followed by "Run it locally"

The "Run it locally" section begins with this note

⚠️ Running Docs locally using the methods described below is for testing purposes only. It is based on building Docs using Minio as the S3 storage solution but you can choose any S3 compatible object storage of your choice.

But then there is no section explaining how to deploy Docs for any situation other than "testing purposes"

Could you add a section about the recommended method to deploy Docs to a production server, as I'm assuming whatever that method is, it differs from what's described in the "Run it locally" section given that warning note.

Is your feature request related to a problem or unsupported use case? Please describe.

My use case is that I'd like to deploy Docs for actual use (not for testing) but don't see how to do that.

Describe the solution you'd like

A section should be added to the README.md that explains how to install/deploy Docs.

Do you want to work on it through a Pull Request?

I would, but I don't yet know how to deploy Docs in order to be able to document the method.

[lunika]

Hi,

You have a first documentation available here : https://github.com/suitenumerique/docs/blob/main/docs/installation.md

It describes how to install Docs on kubernetes. But it's still missing a How to deploy in production.

[virgile-dev]

@gene1wood renamed the issue if that's ok

[gene1wood]

I see. I'd recommend linking to that installation.md in the README.md, but yes, some additional documentation on how one would deploy Docs without using k8s might be useful.

For context, I'm thinking that a small business, or a self-hoster would want to deploy Docs and may not want to use k8s.

[juliamrch]

some additional documentation on how one would deploy Docs without using k8s might be useful.

Hi @gene1wood we're currently working on it with @sampaccoud to include it in this repo, but you can already find some doc here (edit: doc updated). It's adapted to deploy on Clever Cloud, which is relatively generic (yarn and python commands mainly).

[sampaccoud]

There are some minor adaptations necessary. @sylvinus has made it work. Keep posted!

[VolkerFelix]

I see. I'd recommend linking to that installation.md in the README.md, but yes, some additional documentation on how one would deploy Docs without using k8s might be useful.

For context, I'm thinking that a small business, or a self-hoster would want to deploy Docs and may not want to use k8s.

I just deployed it locally on my ubuntu home server. Forked the repo, merged this PR, used "lets encrypt" and created a "How To":
https://github.com/VolkerFelix/docs_home_server/blob/main/docs/installation/compose.md

Maybe this is helpful for you until the official PR is merged

[elijh]

@VolkerFelix Thanks! That is very helpful