Decide what to do with docs.gluster.org

[mscherer]

So I received a email from readthedocs about docs.gluster.org. It seems that on the 1st of october, something will change and we need to change our proxy setup (related to cloudflare SSL).

We need to move the CNAME to readthedocs rather than the current system (eg, a proxy that go to docs.gluster.org).

While I am the one who set the proxy, I do not remember why we did that (maybe it predate the current system)

However:

• that's a separate hosting system
• a separate CI/build system than is not our jenkins
• a separate set of account to manage

So I would propose to:

• do the CNAME change to fix the problem before 1st of october
• investigate a move from RTD to Jenkins and have selfhosted documentation

This will allow to:

• have CI to the docs that is inline with the rest of the project
• evolve the stack more easily

[mscherer]

So the proxy was changed on https://github.com/gluster/gluster.org_ansible_configuration/commit/a67ee6a1d3370db0e40fc754ca6f683b48a98674

No indication why I did that :(

[amarts]

Considering its an opensource documentation, and mostly static, how about shifting to github pages itself, with cname pointing to docs.gluster.org. all we need is a repo with name gluster.github.io and have all MD pages here.

[mscherer]

We would also need to somehow replicate what mkdocs do (eg, a menu, etc). But it can be done with github actions, so I guess whoever do the work decide. It can also be moved to Openshift Online, and we would use a docker container to build it.

There is plenty of options, each differing mostly on details, like small workflow adjustment, and no really bad solutions.

[mscherer]

So seems nothing broke on 1st of october, but I am still going to do the DNS change later today

[nik-redhat]

Is issue #147 somehow related to this?

[mscherer]

Quite possible. We received alerts from nagios related to that, but as we changed nothing, I figured it was a issue on RTD side that would be solved.

[mscherer]

Ok so I propose to move to github actions, and host that on github.

[mscherer]

So here is my first attempt: https://mscherer.github.io/glusterdocs/ , look quite normal to me.

Code: https://github.com/mscherer/glusterdocs/commit/dcfc737ea517a11bbd4434247bbadc33eba76927

@msaju @Shwetha-Acharya @karthik-us @Sheetalpamecha

As you commited on the repo last month, any objection to the move ? If no one object by next week, I will do the move to gh pages.

[Sheetalpamecha]

@mscherer This looks good. I think we can make the changes and move it to gh.

[Shwetha-Acharya]

@mscherer looks good to me as well!

[karthik-us]

@mscherer LGTM.

[msaju]

@mscherer LGTM

[mscherer]

Ok so I moved. I will remove the readthedocs account later

[Sheetalpamecha]

Hi @mscherer, Accessing https://docs.gluster.org/en/latest/ giving me 404- Not Found error.

Is anyone else also facing the same? @karthik-us @Shwetha-Acharya @msaju

PS - Although Traversing inside the site, doesn't give any error. It works well

[nik-redhat]

I think it is because of the readthedocs template that we were using earlier. By default, readthedocs provide "versioning", but after moving to Github pages we don't have that. So, now the home URL is https://docs.gluster.org/ only instead of https://docs.gluster.org/en/latest/

[mscherer]

Ok, should I revert the move for the time being as we want to fix that ?

(that's just a DNS change)

[karthik-us]

I think its better to revert it. Otherwise all the places where we have already posted/using the older links will start giving 404. For example, the links to the release notes on social media or the redirection from https://www.gluster.org/ to the particular section under the Documentation section will be broken.

[mscherer]

Ok, let's revert and try to see how we can build the website like RTD did.

[mscherer]

I am adding a docs-stage.gluster.org, so we can fiddle with github actions setup to replicate RTD.

[mscherer]

So, as I forgot to finish the setup, someone took the domain, and pinged RH infosec, so I removed the domain for now.