Skip to content

Commit ef3d160

Browse files
docs(mdformat): apply markdown table formatting to all docs
Run mdformat to align all markdown table columns for improved readability in raw form. This ensures consistent table formatting throughout the codebase, making tables easier to read and edit in plain text editors. Changes apply formatting to: - Project documentation - Command reference docs - Development guides - User guides - Factory configuration documentation - Component templates Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
1 parent 00c3fb8 commit ef3d160

46 files changed

Lines changed: 139 additions & 140 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.factory/CLOUD_TEMPLATE_GUIDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,12 @@ This skips linting and testing, reducing setup time to ~1-2 minutes.
153153
### Troubleshooting Setup Issues
154154

155155
| Issue | Solution |
156-
|-------|----------|
157-
| "Setup script failed: ..." | Check build logs for specific error. Run the script locally to debug. |
158-
| Command not found (e.g., `task`) | The install command in the setup script should handle this. Check build logs. |
159-
| Slow build time | Remove `task lint` and `task test` from the script if not needed initially. Add them back later. |
160-
| Out of disk space | Cloud templates have adequate storage. Check if the build is trying to cache unnecessarily. |
161-
| Go version mismatch | The cloud environment uses the latest Go LTS version. Check `.github/workflows` for CI Go version. |
156+
| ----- | -------- |
157+
| "Setup script failed: ..." | Check build logs for specific error. Run the script locally to debug. |
158+
| Command not found (e.g., `task`) | The install command in the setup script should handle this. Check build logs. |
159+
| Slow build time | Remove `task lint` and `task test` from the script if not needed initially. Add them back later. |
160+
| Out of disk space | Cloud templates have adequate storage. Check if the build is trying to cache unnecessarily. |
161+
| Go version mismatch | The cloud environment uses the latest Go LTS version. Check `.github/workflows` for CI Go version. |
162162

163163
## Customizing Your Template
164164

@@ -177,4 +177,4 @@ Each template is independent and can have different setup scripts and environmen
177177
3. Share the template with your team
178178
4. Iterate on the setup script based on your workflow needs
179179

180-
For more information, see the [Factory Cloud Templates documentation](https://docs.factory.ai/web/machine-connection/cloud-templates).
180+
For more information, see the [Factory Cloud Templates documentation](https://docs.factory.ai/web/machine-connection/cloud-templates).

.factory/INDEX.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ Complete list of files and resources for DataRobot CLI Cloud Template setup.
6060
### "I want to..."
6161

6262
| Goal | Read This | Use This |
63-
|------|-----------|----------|
64-
| Get started in 2 min | QUICK_START.md | cloud-template-setup-minimal.sh |
65-
| Set up team environment | CLOUD_TEMPLATE_GUIDE.md | cloud-template-setup.sh |
66-
| Understand everything | README.md | Both scripts |
67-
| Find a specific command | QUICK_START.md | See "Common Commands" |
68-
| Customize the setup | README.md | Edit either script |
69-
| Troubleshoot issues | CLOUD_TEMPLATE_GUIDE.md | See "Troubleshooting" section |
70-
| Share with teammates | QUICK_START.md | Copy the setup script |
63+
| ---- | --------- | -------- |
64+
| Get started in 2 min | QUICK_START.md | cloud-template-setup-minimal.sh |
65+
| Set up team environment | CLOUD_TEMPLATE_GUIDE.md | cloud-template-setup.sh |
66+
| Understand everything | README.md | Both scripts |
67+
| Find a specific command | QUICK_START.md | See "Common Commands" |
68+
| Customize the setup | README.md | Edit either script |
69+
| Troubleshoot issues | CLOUD_TEMPLATE_GUIDE.md | See "Troubleshooting" section |
70+
| Share with teammates | QUICK_START.md | Copy the setup script |
7171

7272
## File Structure
7373

@@ -137,12 +137,12 @@ task dev-init # Initialize environment
137137
## Troubleshooting Quick Links
138138

139139
| Issue | Solution |
140-
|-------|----------|
141-
| Setup fails | → See CLOUD_TEMPLATE_GUIDE.md "Troubleshooting" |
142-
| Task not found | → Check PATH or restart terminal |
143-
| Need help | → Read README.md "Troubleshooting" table |
144-
| Want faster setup | → Use cloud-template-setup-minimal.sh |
145-
| Want validation | → Use cloud-template-setup.sh |
140+
| ----- | -------- |
141+
| Setup fails | → See CLOUD_TEMPLATE_GUIDE.md "Troubleshooting" |
142+
| Task not found | → Check PATH or restart terminal |
143+
| Need help | → Read README.md "Troubleshooting" table |
144+
| Want faster setup | → Use cloud-template-setup-minimal.sh |
145+
| Want validation | → Use cloud-template-setup.sh |
146146

147147
## Tips
148148

@@ -165,4 +165,4 @@ These files are part of your repository (in `.factory/`), so you can:
165165
1. Check QUICK_START.md first (fastest)
166166
2. Read CLOUD_TEMPLATE_GUIDE.md (comprehensive)
167167
3. Review README.md (detailed reference)
168-
4. Visit Factory docs: https://docs.factory.ai/web/machine-connection/cloud-templates
168+
4. Visit Factory docs: https://docs.factory.ai/web/machine-connection/cloud-templates

.factory/QUICK_START.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ task run -- version
110110
## Troubleshooting
111111

112112
| Problem | Fix |
113-
|---------|-----|
114-
| "Setup script failed" | Check build logs in Factory UI |
115-
| Task not found | Restart terminal or re-connect |
116-
| Slow build | Use Fast Setup option, add tests later |
117-
| Permissions error | Scripts use `.local/bin` which doesn't need sudo |
113+
| ------- | --- |
114+
| "Setup script failed" | Check build logs in Factory UI |
115+
| Task not found | Restart terminal or re-connect |
116+
| Slow build | Use Fast Setup option, add tests later |
117+
| Permissions error | Scripts use `.local/bin` which doesn't need sudo |
118118

119119
## Next Steps
120120

@@ -124,4 +124,4 @@ task run -- version
124124
4. Share the template URL with your team
125125

126126
📚 **Full Guide:** See `CLOUD_TEMPLATE_GUIDE.md` for detailed docs
127-
📖 **More Info:** See `README.md` for customization & best practices
127+
📖 **More Info:** See `README.md` for customization & best practices

.factory/README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ The setup scripts use [Task](https://taskfile.dev/) - a modern alternative to Ma
107107
Key tasks (from `Taskfile.yaml`):
108108

109109
| Task | Purpose |
110-
|------|---------|
111-
| `task dev-init` | Initialize dev environment, install tools |
112-
| `task lint` | Run all linters (formatting, go vet, golangci-lint, etc.) |
113-
| `task build` | Build the CLI binary to `./dist/dr` |
114-
| `task test` | Run full test suite with race detection |
115-
| `task run` | Run the CLI directly |
116-
| `task run -- <args>` | Run CLI with arguments |
110+
| ---- | ------- |
111+
| `task dev-init` | Initialize dev environment, install tools |
112+
| `task lint` | Run all linters (formatting, go vet, golangci-lint, etc.) |
113+
| `task build` | Build the CLI binary to `./dist/dr` |
114+
| `task test` | Run full test suite with race detection |
115+
| `task run` | Run the CLI directly |
116+
| `task run -- <args>` | Run CLI with arguments |
117117

118118
### Customizing the Setup
119119

@@ -140,12 +140,12 @@ task test-coverage # Generate HTML coverage report
140140
### Troubleshooting
141141

142142
| Issue | Solution |
143-
|-------|----------|
144-
| **Setup fails with timeout** | Check the build logs. The full setup can take 3-5 min. If it exceeds 10 min, use the minimal script. |
143+
| ----- | -------- |
144+
| **Setup fails with timeout** | Check the build logs. The full setup can take 3-5 min. If it exceeds 10 min, use the minimal script. |
145145
| **Task not found after install** | The script installs to `.local/bin`. Ensure PATH is updated. Cloud environments typically have this in PATH. |
146-
| **Permission denied errors** | The minimal setup uses `.local/bin` instead of `/usr/local/bin` to avoid permission issues. |
147-
| **Out of disk space** | Cloud templates have ample storage. Check if Docker containers are not cleaned up from previous builds. |
148-
| **Go version mismatch** | Cloud environments use the latest Go LTS. The CLI should be compatible with Go 1.22+. |
146+
| **Permission denied errors** | The minimal setup uses `.local/bin` instead of `/usr/local/bin` to avoid permission issues. |
147+
| **Out of disk space** | Cloud templates have ample storage. Check if Docker containers are not cleaned up from previous builds. |
148+
| **Go version mismatch** | Cloud environments use the latest Go LTS. The CLI should be compatible with Go 1.22+. |
149149

150150
### Best Practices
151151

@@ -169,4 +169,3 @@ task test-coverage # Generate HTML coverage report
169169
3. Test it from a Factory session
170170
4. Share with your team
171171
5. Customize as needed for your workflow
172-

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ the review may happen while you are asleep / otherwise not able to respond quick
2828
## NOTES
2929
## TESTING
3030
## RELATED
31-
## REVIEWERS -->
31+
## REVIEWERS -->

.github/documentation-style-spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -428,4 +428,4 @@ This specification is based on:
428428
- Go documentation conventions
429429
- Technical writing best practices
430430

431-
For questions or clarifications, consult the full style guide in `.github/style-guide/`.
431+
For questions or clarifications, consult the full style guide in `.github/style-guide/`.

.github/workflows/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,4 @@ Forked PRs require maintainer approval due to security considerations. The `fork
223223
2. **Consistency**: All workflows use the same setup steps and configurations
224224
3. **Maintainability**: Update once, apply everywhere
225225
4. **Readability**: Main workflows focus on orchestration, not implementation details
226-
5. **Testing**: Reusable workflows can be tested independently
226+
5. **Testing**: Reusable workflows can be tested independently

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ DataRobot CLI (`dr`) - A Go-based command-line interface for managing DataRobot
88

99
Use Taskfile tasks rather than raw Go commands:
1010

11-
| Command | Description |
12-
| --------------- | ------------------------------------------- |
11+
| Command | Description |
12+
| ------- | ----------- |
1313
| `task build` | Build the CLI binary (outputs to ./dist/dr) |
1414
| `task lint` | Check for lint issues (read-only) |
1515
| `task delint` | Fix lint and formatting issues |
@@ -112,4 +112,4 @@ Feature gates allow commands to be hidden until ready for release. For comprehen
112112

113113
## PR Output Format
114114

115-
Output change summaries in Markdown format using the template in `.github/PULL_REQUEST_TEMPLATE.md`.
115+
Output change summaries in Markdown format using the template in `.github/PULL_REQUEST_TEMPLATE.md`.

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
7373
[homepage]: https://www.contributor-covenant.org
7474

7575
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,4 +236,4 @@ If you don't get a response within seven days of creating your issue or pull req
236236
- [Release Process](docs/development/releasing.md)
237237
- [User Documentation](docs/)
238238

239-
Thank you for contributing to the DataRobot CLI!
239+
Thank you for contributing to the DataRobot CLI!

0 commit comments

Comments
 (0)