Setup docs: Add installation instructions for Debian and Fedora OS #8491

[0xTheProDev]

Sepearte package available for Google cloud Java API plugin. For Linux system, the package can be directly installed.

Signed-off-by: Progyan Bhattacharya progyanb@acm.org

Fixes #8491

PR Checklist

Ensure that you have:

• Read and understood our PR guideline: https://github.com/TEAMMATES/teammates/blob/master/docs/process.md#step-4-submit-a-pr
  • Added the issue number to the "Fixes" keyword above
  • Titled the PR as specified in the abovementioned document
• Made your changes on a branch other than master and release
• Gone through all the changes in this PR and ensured that:
  • They addressed one (and only one) issue
  • No unintended changes were made
• Run and passed static analysis: ./gradlew lint and npm run lint
• Added/updated tests, if changes in functionality were involved
• Added/updated documentation to public APIs (classes, methods, variables), if applicable

Outline of Solution

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Title
   • Issue Reference (#<issue-number>) missing.
2. PR Description
   • Issue Reference (#<issue-number>) missing.

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Title
   • Issue Reference (#<issue-number>) missing.
2. PR Description
   • Issue Reference (#<issue-number>) missing.

[tshradheya]

@Progyan1997 TEAMMATES follows the following process for contribution.

So before you open a PR, it would be necessary to open an issue about what you aim to do via the PR and get the approval from the project maintainers that the issue is valid and needs to be worked upon.

[0xTheProDev]

@tshradheya This PR improves the Documentation just a bit. This does not help anything with Design or Development of the project.
PS: I can open an issue if it's necessary.

[tshradheya]

Yes, please open an issue. It doesn't matter that even if it is just for Documentation

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Title
   • Issue Reference (#<issue-number>) missing.
2. PR Description

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Title
2. PR Description

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Description

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Description

[wkurniawan07]

Hi @Progyan1997, thanks for the contribution.
However, this does not look like something we really need because the current steps as detailed in the setup document works also for Linux machines, and we don't want to be duplicates of the official setup guide from the Cloud SDK themselves (otherwise we also have to document the apt-get alternative and all the what-nots, right?).

[0xTheProDev]

@wkurniawan07 I am already working on apt for Debian/Ubuntu systems. And the given setup no longer works with RHEL-based systems (at least)

[wkurniawan07]

@Progyan1997 Are you sure just downloading the Java SDK works?

[0xTheProDev]

@wkurniawan07 Yes, that's the way I followed to work with!

[wkurniawan07]

@Progyan1997 as in you don't need to install the Cloud SDK first?

[0xTheProDev]

@wkurniawan07 You must install gcloud package first, although if you don't it will install it anyway for the dependencies. But my point was gcloud is not allowed to install java-plugin, it must be installed separately as a package.

[wkurniawan07]

@Progyan1997 are you sure the install commands with apt-get or yum work just like that without setting up the configurations?

[0xTheProDev]

@wkurniawan07 Please explain what you said.

[wkurniawan07]

According to this and this (the "Before you begin" part) there are some things that need to be done.

[0xTheProDev]

@wkurniawan07 That is for installing gcloud, the parent module. I think it's already present in the documentation.

[wkurniawan07]

@Progyan1997 it is not; our current setup docs make no mention to yum/apt-get-based installation other than a reference to the official installation page. So, installing app-engine-java with apt-get or yum works without the need for the configuration set out in the "Before you begin" part?

[0xTheProDev]

@wkurniawan07 Then should I add those information as well?

[wkurniawan07]

Before you proceed further, have you tried that the entire setup (up to building/testing/deploying) works in any one of those OSes?
The setting up/development guideline is field-tested and actively maintained for Linux (Travis CI, although strictly speaking it's Ubuntu Trusty), Windows (AppVeyor), and Mac OS (my own setup). If we want to add support for any new OS, we need to make sure that (1) the entire routine works and (2) the setup is at least used by someone. We don't want to end up adding something now only for someone later to complain "this instruction does not work for me" and we don't have any resource/know-how to help.

[0xTheProDev]

@wkurniawan07

Before you proceed further, have you tried that the entire setup (up to building/testing/deploying) works in any one of those OSes?

Yes, I did indeed. The given procedure did not work with CentOS 7, at least that was my experience. So I had to follow the official documentation and proceed with the mentioned steps. Since I am adding yum support, I thought of providing apt package informations as well.

We don't want to end up adding something now only for someone later to complain "this instruction does not work for me"

The previous documentations are kept as is, because most probably it works with other Linux distributions as well as Windows. Personally I would recommend to follow them, and then mine only if it does not work.

[wkurniawan07]

I'd recommend the following:

• In the step which installs Google Cloud SDK, add a reference to the official docs for Debian/Ubuntu/Red Hat/CentOS. Something like "If you use Debian/Ubuntu/Red Hat/CentOS, the installation is slightly more complicated. Refer to the official documentation provided by Google.". It is too wordy for everything to be duplicated here.
• In the step which installs App Engine Java, it is acceptable to mention yum/apt-get provided the above is done, but you don't need new code blocks for that (and the header is rather disruptive). Just do something like:

  # Linux/OS X/Windows
  gcloud -q components install app-engine-java
  
  # Debian/Ubuntu
  sudo apt-get install google-cloud-sdk-app-engine-java

[0xTheProDev]

@wkurniawan07

In the step which installs Google Cloud SDK, add a reference to the official docs...
... you don't need new code blocks for that...

Made the above changes as you recommended.

[wkurniawan07]

• You're still mixing up installing Cloud SDK and installing App Engine Java.
• Let's not use abbreviation for "Red Hat".

[0xTheProDev]

@wkurniawan07 Have a look.

[wkurniawan07]

No need to include them for the following reasons:

• They are mentioned in the official docs
• If you only display them like this, it's unlikely to work because the "Before you begin" steps are not done

If anything, just do what I suggested: "If you use Debian/Ubuntu/Red Hat/CentOS, the installation is slightly more complicated. Refer to the official documentation provided by Google."

[0xTheProDev]

Okay 👍

[wkurniawan07]

This is about installing the Cloud SDK; if everything was done right before, the yum and apt-get commands down here would have worked.

[wkurniawan07]

Minor readability tweaks:

• Red Hat/CentOS/Fedora/Debian/Ubuntu -> Red Hat, CentOS, Fedora, Debian, or Ubuntu
• Ubuntu follow -> Ubuntu, refer to
• official documentation -> quickstart guide
• Google Cloud Engine -> Google Cloud SDK
• RHEL -> Red Hat

[0xTheProDev]

@wkurniawan07 Done 😄

[teammates-bot]

Hi @Progyan1997, these parts of your pull request do not appear to follow our contributing guidelines:

1. PR Description

[wkurniawan07]

LGTM