Mentorship-backend: docs: Update environment variables declarations in documentation

Created on 12 Jan 2021  路  9Comments  路  Source: anitab-org/mentorship-backend

Describe the bug

As a developer,
I would like to be able to install and repository on my local system. Using any development configuration other than "local", requires one to add a few more environment variables. One of them, the declaration of "MOCK_EMAIL" has a slight misprint, due to which newcomers might face problems in settings up the repo. The issue is that there is whitespace between "MOCK_EMAIL" , "=" and "True/False" in the documentation, which if included in the cli too, will produce an error. This small misprint can be quickly fixed and might help in saving a bit more debugging time for newcomers.

To Reproduce

Steps to reproduce the behavior:

  1. Open up your CLI and cd into your fork of mentorship-backend repository
  2. Declare new environment variable as MOCK_EMAIL = True (please note the spaces in between)
  3. Error from bash : -bash: export: `=': not a valid identifier

Expected behavior
Removing the spaces from the declarations will resolve the issue and not return any errors, the env variable will be set.

Screenshots
image

Desktop (please complete the following information):

  • OS: MacOS
  • Version 10.14.5 Mojave
  • Tested on Terminal

Additional context
This issue might seem a bit too trivial to raise, but I thought it might help newcomers in setting up the repo on their system. I will be eager to quickly make a patch for the issue and make the required changes in the docs.

DocumentatioTraining First Timers Only

All 9 comments

@isabelcosta @vj-codes What do you think about this issue? If you think that this needs to be fixed, I would go ahead and create a PR to address the same. Eagerly awaiting your reviews. Thanks!

@sankha555 hey nice catch here !
Was able to reproduce it on my side, another observation is that set which is used on Windows OS allows spaces ,but export doesn't and thus issue is valid :)
Since this is a relatively easy fix let's keep this open for newcomers only.
Thank you for creating the issue馃帀
image

Sure @vj-codes , this will be a good issue to get newcomers started. Thanks for your motivating words! 馃槃

Hi @sankha555 I would like to work on this.
Do we have to check how this works on MacOS and Version 10.14.5 Mojave also?

@battuAshita hey thanks for your interest! However, I can't assign the issue to you as I am not authorized to do so. You can tag the maintainers for the same!

Yes, this change will mostly be required in ubuntu and macOS systems. The change should be same across all versions of macOS, so a change in any of the version should work fine :smile:. Do ask here if you need any further help!

@battuAshita hey thanks for your interest! However, I can't assign the issue to you as I am not authorized to do so. You can tag the maintainers for the same!

Yes, this change will mostly be required in ubuntu and macOS systems. The change should be same across all versions of macOS, so a change in any of the version should work fine . Do ask here if you need any further help!

Thank you @sankha555. Sure, will ask in case of further help.

Hi @vj-codes I would like to work on this. Can this issue be assigned to me?

Assigning you @battuAshita
Happy documenting!
Do remember to follow our commit message style guide :)

@vj-codes I have raised a PR #974. Please review.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mtreacy002 picture mtreacy002  路  6Comments

daksha-aeer picture daksha-aeer  路  6Comments

isabelcosta picture isabelcosta  路  3Comments

isabelcosta picture isabelcosta  路  7Comments

isabelcosta picture isabelcosta  路  5Comments