Skip to content

Commit 084f59a

Browse files
committed
docs: refactoring readme for local setup with docker
1 parent 1552216 commit 084f59a

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachabl
33
This guide will give you an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
44

55
# Local Setup
6-
- Follow [Setup Guide](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20with%20Docker.md) for setting up the project locally.
6+
- Follow [Setup Guide](/docs/“How-to”%20guides/User%20Guides/Local%20Developer%20Setup/Local%20Setup%20with%20Docker.md) for setting up the project locally.
77

88
# Issues
99

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ Enigma access management tool was developed internally at BrowserStack to solve
4747

4848
The following steps are for hosting Enigma locally from published docker container images.
4949

50-
For development setup, follow these docs [using docker](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20with%20Docker.md),
51-
[without docker](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20without%20Docker.md)
50+
For development setup, follow these docs:
51+
[Setup using docker](/docs/“How-to”%20guides/User%20Guides/Local%20Developer%20Setup/Local%20Setup%20with%20Docker.md),
52+
[Setup without docker](/docs/“How-to”%20guides/User%20Guides/Local%20Developer%20Setup/Local%20Setup%20without%20Docker.md)
5253

5354
#### Pre-requisites
5455

docs/“How-to” guides/Managing Groups/Adding Users.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This document describes how to add users to a group on Enigma.
22

3-
A user has to be successfully onboarded on Enigma before they can be added to a group. (Refer: [User Creation](../Adding%20Users.md))
3+
A user has to be successfully onboarded on Enigma before they can be added to a group. (Refer: [User Creation](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/Adding%20Users.md))
44

55
To add users to a group:
66
- Select 'Add New Members' from Group section in the left side panel on Enigma Dashboard.

docs/“How-to” guides/User Guides/Setup Enigma Locally/Local Setup with Docker.md docs/“How-to” guides/User Guides/Local Developer Setup/Local Setup with Docker.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Setup for Local Development
1+
# Setup for Local Development With Docker
22

3-
## Pre-requisistes
3+
## Pre-requisites
44

55
### Install Docker
66

docs/“How-to” guides/User Guides/Setup Enigma Locally/Local Setup without Docker.md docs/“How-to” guides/User Guides/Local Developer Setup/Local Setup without Docker.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setup Enigma Locally Without Docker
1+
# Setup for Local Development Without Docker
22

33
## Pre-requisites
44
You should have python3 installed on your system and checked out the enigma repository locally.
@@ -15,7 +15,7 @@ For detailed instructions on configuration, follow [this doc](/docs/Configuratio
1515
2. Add folder `db` in root folder of the repository.
1616
3. Add a package `access_modules` inside `Access`.
1717

18-
Copy this [file](../../../../Access/base_email_access/access_modules_init.py) as `__init__.py` of `access_modules`
18+
Copy this [file](/Access/base_email_access/access_modules_init.py) as `__init__.py` of `access_modules`
1919

2020
4. Add access modules inside `access_modules` to integrate them with Enigma. (Optional and not needed to get started)
2121

0 commit comments

Comments
 (0)