PR#2528: doc: python support matrix - koji

koji

#2528 doc: python support matrix

Merged 3 years ago by tkopecek. Opened 3 years ago by tkopecek.

tkopecek/koji issue356 into master

remove empty section

Tomas Kopecek • 3 years ago

7022641

doc: python support matrix

Tomas Kopecek • 3 years ago

b2892db

docs/source/index.rst

file modified

		`@@ -49,6 +49,7 @@`
		`content_generator_metadata`
		`configuring_jenkins`
		`utils`
		`+ supported_platforms`

		`HowTos`
		`======`

docs/source/supported_platforms.rst

file added

+13

		`@@ -0,0 +1,13 @@`
		`+ Supported Platforms`
		`+ ===================`
		`+`
		`+ We're now supporting Linux systems which have at least python 2.7 for`
		`+ builders and 3.6 for other components. These versions are minimal (so,`
		`+ everywhere where is 2.7 support it means 2.7+ and 3.0+. Currently it`
		`+ involves all active Fedoras and RHEL/CentOS 7+.`
		`+`
		`+ +-----------+-----+-----+---------+-------+-----+-----+`
		`+ \| Component \| Hub \| Web \| Builder \| Utils \| Lib \| CLI \|`
		`+ +===========+=====+=====+=========+=======+=====+=====+`
		`+ \| Python \| 3.6 \| 3.6 \| 2.7 \| 3.6 \| 2.7 \| 2.7 \|`
		`+ +-----------+-----+-----+---------+-------+-----+-----+`

docs/source/writing_koji_code.rst

file modified

		`@@ -14,6 +14,11 @@`
		`understanding of Koji's architecture to be able to estimate how much`
		`work is still ahead of them.`

		`+ Koji is written to support a variety of platforms and python versions,`
		`+ with some portions of Koji supported over a larger set than others.`
		`+ When making changes, please be considerate of those`
		+ :doc:`supported_platforms`.
		`+`
		`Task Flow`
		`=========`

tkopecek commented 3 years ago

Fixes: https://pagure.io/koji/issue/356

Metadata Update from @tkopecek:
- Pull-request tagged with: doc

3 years ago

Metadata Update from @tkopecek:
- Pull-request tagged with: no_qe

3 years ago

rebased onto d677f30e34d8c2846a398bfaa9d3a205b825a31b

3 years ago

mikem commented 3 years ago

I'm not sure if this belongs under the release process heading. For that matter, I'm not sure it belongs in the writing_koji_code document. The support matrix is of interest to folks that never look at code.

Minor: "Linux" should be capitalized.

As far as the table goes, we should probably indicate some sort of range. I guess 3.6 means 3.6+, but perhaps we should be explicit. Likewise, for the lib and cli, we of course support python versions over 2.7.

mikem commented 3 years ago

Maybe it would be better to have a "Supported Platforms" document that includes this matrix leaves us room for more explanation.

We could link that document in the writing_koji_code file with a note along the lines of: "Koji is written to support a variety of platforms and python versions, with some portions of Koji supported over a larger set than others. When making changes, please be considerate of those supported platforms [link].

rebased onto b2892db

3 years ago

mikem commented 3 years ago

There is an empty section in writing_koji_code now ("Supported OS"). Did you mean to remove this in favor of the addition under "Getting started" or should this also have a link to the new page?

1 new commit added