Skip to content

Commit

Permalink
docs: modifications to markdown files (publiclab#9582)
Browse files Browse the repository at this point in the history
  • Loading branch information
rkpattnaik780 authored and billymoroney1 committed Dec 28, 2021
1 parent 84f999d commit c743553
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Secure connection is needed for OAuth authentication etc.

## Login

Once you complete the installation, use any of these credentials to login in to the PL website in your local development / testing environment to gain additional permissions for logged in users only. Each one comes with its own set of permissions; nevertheless, the experience across them is pretty much the same.
Once you complete the installation, use any of these credentials to login into the PL website in your local development/testing environment to gain additional permissions for logged in users only. Each one comes with its own set of permissions; nevertheless, the experience across them is pretty much the same.

**username**: `admin`, `moderator`, or `user`

Expand Down
2 changes: 1 addition & 1 deletion doc/MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Each type comes with a different "attitude" towards merging. Some need to be REA
3. maintain commenting from a mobile phone
4. maintain comment-by-email
5. simplify and clean commenting code
6. consolidate and refine commenting cdoe
6. consolidate and refine commenting code
7. increase test coverage, esp. full-stack system tests

## Editor maintainers
Expand Down
2 changes: 1 addition & 1 deletion doc/PREREQUISITES.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You'll also need **yarn** to get your JavaScript dependencies.

Use `yarn --version` to verify whether the installation is up and running!

**Note:** In case the options described above do not work for you, you can also install yarn using npm,though it is generally not recommended. As a prerequisite, you will have to [install Node.js](https://nodejs.org/en/download/) if not already installed.
**Note:** In case the options described above do not work for you, you can also install yarn using npm, though it is generally not recommended. As a prerequisite, you will have to [install Node.js](https://nodejs.org/en/download/) if not already installed.
To install yarn using npm, use `npm install --global yarn` and continue with path setup similar to the usual installation.

### phantomjs for javascript tests (optional)
Expand Down
2 changes: 1 addition & 1 deletion doc/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ And to run just a single test within a file:
### Testing mails in development environment

We are using 'letter_opener' gem to open the mails in development environment.
Whenever a email is sent then it will automatically catch by letter_opener and it will open in new window in development environment, nothing is to be done to run it, it will be done automatically.
Whenever an email is sent then it will automatically catch by letter_opener and it will open in new window in development environment, nothing is to be done to run it, it will be done automatically.
Same links would work, no modification in links are required.
It will also show us how our actual mail will look like.
Mail will be same as actual mail we will get in production.
Expand Down
2 changes: 1 addition & 1 deletion doc/reply_by_tweet.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

- If that twitter username is present in the `user_tags` column then add the tweet otherwise ignore the current tweet.

- Same process is with when there are no comment present with tweet_id in the comment table where we search for all the replied tweets to the `publiclab`.
- Same process is with when there are no comments present with tweet_id in the comment table where we search for all the replied tweets to the `publiclab`.

To use this feature we have to set some environment variables which includes Twitter API keys and Searching Query: For getting Twitter Keys go to [Twitter app keys](https://apps.twitter.com/)
Environment variables used for twitter keys are : `TWITTER_CONSUMER_KEY`, `TWITTER_CONSUMER_SECRET`, `TWITTER_ACCESS_TOKEN` and `TWITTER_ACCESS_TOKEN_SECRET`.
Expand Down

0 comments on commit c743553

Please sign in to comment.