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
Remove RPM - docs are based on Ubuntu #459
Conversation
svx
commented
Dec 2, 2015
- Remove RPM, docs are base on Ubuntu, we do not want to confuse user
Needs discussion, I remember smcmahon adding stuff to the installer docs under the clear motto "treat RPM based distributions as first class citizen". We do not want to scare away non-DEB based users, removing all mention of that may have that unintended effect instead of 'not confusing'.... |
As I was pointing on #461 if we are directing users towards ansible and such, then it does not matter rpm/deb and what not, only the package names... (my third cent :-) |
ahem no really.... the only thing that we have in the installer docs are the basics dependencies to install plone on various linux platforms, we removed on other places of the docs already the mentions of rpm, osx and further we name this only is they are really needed for them. We clearly stated also in: http://docs.plone.org/manage/installing/installation.html#how-to-install-plone that the docs are based on ubuntu ..... |
@gforcada but that is for the full stack not if you have already plone installed, telling ppl that you 'have' to use ansible is IMHO not OK |
on a further note: @polyester that would mean to add not only rpm but also other package formats, to avoid that we decided a long time ago, to base the docs on Ubuntu LTS. So yes, maybe that is not perfect but at least it is more consistent with the rest of the docs ! |
@svx but it is inconsistent here also; in varnish4.rst you want to remove RPM, leave DEB, but then two lines later it says "For more up to date packages for RedHat (RPM Based) you could check: https://www.varnish-cache.org/installation/redhat" Which I think is perfectly fine, and actually a help to the user. So I would propose to re-write it 'distribution-neutral' where possible, but with links that help the user. So, remove both (RPM/DEB) so that it says "preferebly, install with , but leave the links to the varnish docs. So something like The suggest method to install Varnish is to use your OS package manager - consult your operating system instructions.
(UPDATED: link should be https://www.varnish-cache.org/docs, not https://www.varnish-cache.org/install as that doesn't work on it's own) |
@polyester like i said before this is not consistent with all the other docs, and we made this decision long time before you were even on the docs team, if you want to re-discuss fine, but this should be a discussion in general and not only about one tiny part of the docs. So for now I go with the old decision because that is on what the whole docs are based atm |
OK, I am merging that, because that is the right thing to do. Reason: This change follows the current setup of the docs. meaning based on Ubuntu LTS, and for this it actually improves the docs, because it is removing a possible confusing note. @polyester if you think basing the docs on Ubuntu should be discussed again, please open a discussion for that ! |
Remove RPM - docs are based on Ubuntu
@svx I did not want to discuss basing the docs on Ubuntu LTS, but there is a difference between
and
In this case, I think my suggestion would have achieved that better. But since I'm a newcomer, whatever. |
@polyester still this needs to be a discussion about the whole docs in general. That is why I stated open up a discussion. Just changing one tiny part and have this part different will not help at all, so yes I stand to my merge because it follows what we have currently |
@polyester This is from your suggestion but based on that I would like to ask why you just mention these ones, what is with Fedora server, what is with Arch, Gentoo, Nix or other ones ? In this case I think you suggestion was not the better way, sorry It may be a valid point to discuss to change the whole docs to be more 'OS neutral' but please do that properly ! There are many different points which you have to think about, but this should be done first, |
+1 for distribution neutrality where possible. saying "install using packages (RPM/DEB)" sounds like these are the only supported package formats. this is even stronger when removing the RPM part. mentioning a package format adds not much information anyways in this context. i'm currently a fedora, thus RPM user. |
I am not against it, but I am saying first talk about that in a own ticket or on community, please :) This has impact in lots of parts of the docs, and for this we need to think how to solve that in a proper way, starting from installer, lost of examples and so on and so on. We need to find good solutions for that first, it is IMHO not the best idea to start change one tiny part of the docs, before thinking about the docs as the 'whole' docs and all possible challenges first. |
I basically agree - I don't think we should have distribution neutrality for installation documentation - IIRC we even have a section for vagrant for people don't have the discussed distribution or are on windows. |