Skip to content

Commit d6101b9

Browse files
committed
Update internal readme
1 parent 1516e1f commit d6101b9

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

usage-examples/go/atlas-sdk-go/INTERNAL_README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,36 @@
11
# Atlas SDK for Go
22

33
> 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.
55
66
This project demonstrates how to script specific functionality using the Atlas
77
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":
99
https://github.com/mongodb/atlas-architecture-go-sdk.
1010

1111
## Project Structure
1212
```text
1313
.
14-
├── cmd/ # Self-contained, runnable examples by category
14+
├── examples/ # Self-contained, runnable examples by category
15+
│ ├── billing/
16+
│ └── monitoring/
1517
├── 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)
1719
├── go.mod
1820
├── CHANGELOG.md # User-facing list of major project changes
1921
│── README.md # User-facing README for copied project
2022
│── 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
2224
│ └── bluehawk.sh
23-
├── .gitignore
24-
└── .env.example
25+
├── .gitignore # Ignores .env file and log output
26+
└── .env.example # Example environment variables
2527
```
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`.
2629

2730
## Adding Examples
2831
To add examples to the project:
2932

30-
33+
[TODO]
3134

3235
## Runnable Scripts
3336
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.
6568
6669
## Write Tests
6770
68-
... TODO
71+
[TODO]
6972
7073
## Generate Examples
7174

0 commit comments

Comments
 (0)