1785943 - Bugzilla Installation documentation is out of date

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Dave Miller [:justdave]]

The examples in the docs use ancient versions of the OSes that are given as sample installs, and no sane person is going to be using an OS that old on a new install. So the installation sections of the docs need to be updated to use modern versions of the OSes in the instructions and examples.

https://bugzilla.readthedocs.io/en/5.0/installing/index.html

The source for those pages is at docs/en/rst inside the Bugzilla repo

4.4, 5.0, 5.2, and harmony branches all need updating.

Comment 1

[Dave Miller [:justdave]]

Attachment: GitHub Pull Request for 5.0.4 branch

Comment 2

[Dave Miller [:justdave]]

Attachment: GitHub Pull Request for 5.2 branch

Comment 3

[Dave Miller [:justdave]]

ok, that leaves 4.4 and Harmony.... and Harmony looks like it probably needs a little more than installation docs updated...

Comment 4

[Jay Michalska [:hellcp]]

4.4 documentation still mentions bzr, which is fun. It may require some closer look because there may be some really legacy stuff that really shouldn't be there anymore.

My last shot at installing Harmony ended up with TEST-FAILED Webserver is not executing CGI files., with Apache config that worked fine with 5.0 and 5.2, so it may require some more changes on that front, but I think it could be valuable to diff the current documentations and see what could be transferred over from the old doc to Harmony, since it currently has barely any documentation wrt installation, apart from the docker README.md.

Comment 5

[Dave Miller [:justdave]]

We likely need Dylan involved in the installation instructions for harmony...

As for 4.4... https://bzr.bugzilla.org/ still exists. For now. It's going away as soon as the 4.4 branch is EOLed. Which is 4 months after whenever 5.2 releases.

Comment 6

[Dave Miller [:justdave]]

I guess I should NI Dylan for that, he's not CCed on this bug.

Comment 7

[Dave Miller [:justdave]]

4.4's documentation does not have an Ubuntu QuickStart, which is the part that was outdated on the other branches. The main install docs are probably still appropriate for the older OSes that you can still get 4.4's dependencies on, and I'd hate to see someone installing a 4.4 as a new install these days anyway.

Comment 8

[Dave Miller [:justdave]]

We're going to treat Harmony differently for this because it's an entirely different beast, and will need completely different documentation, which is being worked on as a separate project.

Since the remaining branched mentioned are both merged already, this is now fixed.

5.0.4 branch: https://github.com/bugzilla/bugzilla/commit/1f505160b5288243c26355c3177025dba2cc2317
5.2 branch: https://github.com/bugzilla/bugzilla/commit/b93cad6edf04e485a1c66c2926f509121f5dfe41