|
1 | 1 | # Atlas SDK for Go
|
2 | 2 |
|
3 | 3 | > NOTE: This is an internal-only file and refers to the internal project details.
|
4 |
| -> The external project details are documented in the README.md file. |
| 4 | +> User-facing project details are documented in the [README.md](README.md) file, which is copied to the artifact repo. |
5 | 5 |
|
6 | 6 | This project demonstrates how to script specific functionality using the Atlas
|
7 | 7 | SDK for Go. Code examples are used in the Atlas Architecture Center docs, and
|
8 |
| -a sanitized copy of the project is available in a user-facing repo: |
| 8 | +a sanitized copy of the project is available in a user-facing "artifact repo": |
9 | 9 | https://github.com/mongodb/atlas-architecture-go-sdk.
|
10 | 10 |
|
11 | 11 | ## Project Structure
|
12 | 12 | ```text
|
13 | 13 | .
|
14 |
| -├── cmd/ # Self-contained, runnable examples by category |
| 14 | +├── examples/ # Self-contained, runnable examples by category |
| 15 | +│ ├── billing/ |
| 16 | +│ └── monitoring/ |
15 | 17 | ├── configs/ # Atlas details
|
16 |
| -├── internal # Shared utilities and helpers (NOTE: ANY TEST FILES ARE INTERNAL ONLY) |
| 18 | +├── internal # Shared utilities and helpers (NOTE: ALL TEST FILES ARE INTERNAL ONLY - DON'T COPY TO ARTIFACT REPO) |
17 | 19 | ├── go.mod
|
18 | 20 | ├── CHANGELOG.md # User-facing list of major project changes
|
19 | 21 | │── README.md # User-facing README for copied project
|
20 | 22 | │── INTERNAL_README.md # (NOTE: INTERNAL ONLY - DON'T COPY TO ARTIFACT REPO)
|
21 |
| -│── scripts/ # (NOTE: INTERNAL ONLY) snip and copy code examples |
| 23 | +│── scripts/ # (NOTE: INTERNAL ONLY) Script to generate code examples |
22 | 24 | │ └── bluehawk.sh
|
23 |
| -├── .gitignore |
24 |
| -└── .env.example |
| 25 | +├── .gitignore # Ignores .env file and log output |
| 26 | +└── .env.example # Example environment variables |
25 | 27 | ```
|
| 28 | +Unless noted, all files are Bluehawk-copied to the generated `project-copy` dir, then copied to the artifact repo. This includes `.gitignore` and `.env.example`. |
26 | 29 |
|
27 | 30 | ## Adding Examples
|
28 | 31 | To add examples to the project:
|
29 | 32 |
|
30 |
| - |
| 33 | +[TODO] |
31 | 34 |
|
32 | 35 | ## Runnable Scripts
|
33 | 36 | You can run individual scripts from the terminal. For example, to run `get_logs/main.go`:
|
@@ -65,7 +68,7 @@ Contact the Developer Docs team with any setup questions or issues.
|
65 | 68 |
|
66 | 69 | ## Write Tests
|
67 | 70 |
|
68 |
| -... TODO |
| 71 | +[TODO] |
69 | 72 |
|
70 | 73 | ## Generate Examples
|
71 | 74 |
|
|
0 commit comments