Skip to content

Commit 7e6e9f6

Browse files
committed
docs: refactoring readme for enigma local setup
1 parent 0c82d7c commit 7e6e9f6

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
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/one-click-dev.md) for setting up the project locally.
6+
- Follow [Setup Guide](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20with%20Docker.md) for setting up the project locally.
77

88
# Issues
99

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Refer to [this doc](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/Adding%20Modules.md)
1313

1414
The following steps are for hosting Enigma locally from published docker container images.
1515

16-
For development setup, follow this [doc](/docs/one-click-dev.md)
16+
For development setup, follow these docs [using docker](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20with%20Docker.md),
17+
[without docker](/docs/“How-to”%20guides/User%20Guides/Setup%20Enigma%20Locally/Local%20Setup%20without%20Docker.md)
1718

1819
### Pre-requisistes
1920

docs/“How-to” guides/User Guides/First User Setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To setup admin user on enigma, follow these steps:
44

55
1. Setup django superuser
66

7-
- Exec into the Enigma container
7+
- Exec into the Enigma container if you are using docker
88

99
```bash
1010
docker exec -it enigma bash

docs/one-click-dev.md renamed to docs/“How-to” guides/User Guides/Setup Enigma Locally/Local Setup with Docker.md

File renamed without changes.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Setup Enigma Locally
1+
# Setup Enigma Locally Without Docker
22

33
## Pre-requisites
44
You should have python3 installed on your system and checked out the enigma repository locally.
@@ -7,15 +7,15 @@ You should have python3 installed on your system and checked out the enigma repo
77
## Steps
88
1. Ensure you have a valid `config.json` present locally.
99

10-
The default [config.json.sample](https://github.com/browserstack/enigma-public-central/blob/main/config.json.sample) should be sufficient to start.
10+
The default [config.json.sample](https://github.com/browserstack/enigma/blob/main/config.json.sample) should be sufficient to start.
1111

1212
You can then add module-specific configuration for the modules you want integrated with Enigma.
1313
For detailed instructions on configuration, follow [this doc](/docs/Configuration%20Guide.md)
1414

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

@@ -31,7 +31,7 @@ Copy each access module folder that you want to support manually here ensuring d
3131
|--|--|-- __init__.py
3232
|--|--|-- access.py
3333
```
34-
For detailed instructions on how to add modules, follow [this doc](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/Adding%20Modules.md)
34+
For detailed instructions on how to add modules, follow [this doc](/docs/“How-to%20guides/Adding%20Modules.md)
3535

3636
5. Install all the requirements through requirements.txt and ensure dependencies for access modules are installed
3737
```
@@ -50,4 +50,4 @@ Ensure that the 8000 port is free to use.
5050

5151
That's it! Enigma should be running locally on port 8000 http://localhost:8000
5252

53-
For first time user sign-in, follow [this doc](/docs/%E2%80%9CHow-to%E2%80%9D%20guides/User%20Guides/First%20User%20Setup.md)
53+
For first time user sign-in, follow [this doc](/docs/“How-to%20guides/User%20Guides/First%20User%20Setup.md)

0 commit comments

Comments
 (0)