Skip to content

Commit fd0ee99

Browse files
author
github-actions
committed
Sync docs from emma repo
1 parent 9d339b7 commit fd0ee99

File tree

11 files changed

+30
-30
lines changed

11 files changed

+30
-30
lines changed

docs/docs-emma/features/data-import-export.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,4 +341,4 @@ Exported data includes:
341341
- Increase timeout settings
342342
- Monitor export progress
343343

344-
For detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).
344+
For detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).

docs/docs-emma/features/schema-builder.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,4 @@ For more troubleshooting help, see the [Troubleshooting Guide](../reference/trou
204204

205205
- Try the [Building Your First Schema](../guides/building-your-first-schema) guide
206206
- Explore the [Schema Library](https://docs.infrahub.app/schema-library) for examples and templates
207-
- Learn about [Schema Management](./schema-management) best practices
207+
- Learn about [Schema Management](./schema-management) best practices

docs/docs-emma/features/schema-management.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,4 +353,4 @@ For detailed troubleshooting, see the [Troubleshooting Guide](../reference/troub
353353
- Explore the [Schema Library](https://docs.infrahub.app/schema-library) for available schemas
354354
- Try [Building Your First Schema](../guides/building-your-first-schema)
355355
- Learn about [Data Import & Export](./data-import-export) for populating your schemas
356-
- Check out the [Schema Builder](./schema-builder) for creating custom schemas
356+
- Check out the [Schema Builder](./schema-builder) for creating custom schemas

docs/docs-emma/getting-started/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,4 +176,4 @@ Emma validates your configuration on startup. Common configuration issues:
176176
- **Authentication errors**: Verify your API token is valid and has necessary permissions
177177
- **Connection timeouts**: Increase timeout values for slow networks
178178

179-
For detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).
179+
For detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).

docs/docs-emma/getting-started/first-steps.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Welcome to Emma! This guide will walk you through your first experience using Em
66

77
## Opening Emma
88

9-
1. **Navigate to Emma** at http://localhost:8501 (or your configured port)
9+
1. **Navigate to Emma** at `http://localhost:8501` (or your configured port)
1010
2. **Verify connection** - Emma should show a connection status to your Infrahub instance
1111
3. **Select a branch** - Choose which Infrahub branch to work with (usually `main`)
1212

@@ -108,4 +108,4 @@ If you encounter issues:
108108
- Review feature-specific documentation in the Features section
109109
- Remember that Emma is experimental - some features may not work as expected
110110

111-
Emma is designed to make working with Infrahub more accessible and efficient. Take your time to explore each feature and don't hesitate to experiment!
111+
Emma is designed to make working with Infrahub more accessible and efficient. Take your time to explore each feature and don't hesitate to experiment!

docs/docs-emma/getting-started/installation.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Emma is an experimental AI-powered assistant for Infrahub that helps you manage
1212
Before installing Emma, ensure you have:
1313

1414
- **Infrahub instance**: Emma requires a running Infrahub instance to connect to
15-
- **Docker** (for containerized deployment) or **Python 3.10+** and **Poetry** (for local development)
15+
- **Docker** (for containerized deployment) or **Python 3.10+** and **uv** (for local development)
1616

1717
## Installation methods
1818

@@ -23,15 +23,15 @@ The easiest way to get started is using the Infrahub quickstart with Emma includ
2323

2424
```bash
2525
# Download and start Infrahub + Emma with Docker Compose
26-
curl https://infrahub.opsmill.io/1.4.12-emma | docker compose -f - up -d
26+
curl https://infrahub.opsmill.io/1.6.2-emma | docker compose -f - up -d
2727
```
2828

2929
This command will:
3030

3131
- Download the latest Infrahub and Emma configuration
3232
- Start both services with proper networking
33-
- Make Emma available at http://localhost:8501
34-
- Make Infrahub available at http://localhost:8000
33+
- Make Emma available at `http://localhost:8501`
34+
- Make Infrahub available at `http://localhost:8000`
3535

3636
:::tip
3737
Update the version number in the URL to the [latest Infrahub release](https://github.com/opsmill/infrahub/tags) for the most recent features.
@@ -65,7 +65,7 @@ docker network ls
6565
docker network connect <infrahub-network-name> emma-emma-1
6666
```
6767

68-
Emma will be available at http://localhost:8501
68+
Emma will be available at `http://localhost:8501`
6969

7070
</TabItem>
7171
<TabItem value="local" label="Local Development">
@@ -79,19 +79,19 @@ git clone https://github.com/opsmill/emma.git
7979
cd emma
8080
```
8181

82-
2. **Install dependencies with Poetry:**
82+
2. **Install dependencies with uv:**
8383

8484
```bash
85-
poetry install
85+
uv sync
8686
```
8787

8888
3. **Run Emma:**
8989

9090
```bash
91-
poetry run streamlit run main.py
91+
uv run streamlit run main.py
9292
```
9393

94-
Emma will start on http://localhost:8501
94+
Emma will start on `http://localhost:8501`
9595

9696
</TabItem>
9797
</Tabs>
@@ -108,4 +108,4 @@ If you encounter issues during installation:
108108
- **Docker issues**: Check Docker is running and you have sufficient resources allocated
109109
- **Network connectivity**: Verify Emma can reach your Infrahub instance
110110

111-
For more detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).
111+
For more detailed troubleshooting, see the [Troubleshooting Guide](../reference/troubleshooting).

docs/docs-emma/guides/building-your-first-schema.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,4 +270,4 @@ Congratulations! You've created your first schema with Emma. Here's what to expl
270270
- [Data Import & Export](../features/data-import-export.mdx) - Advanced data import techniques
271271
- [Infrahub Schema Documentation](https://docs.infrahub.app/reference/schema/) - Official schema reference
272272

273-
You're now ready to build more complex schemas and models with Emma!
273+
You're now ready to build more complex schemas and models with Emma!

docs/docs-emma/readme.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Ready to get started? Choose your preferred installation method:
4040
Use the one-command quickstart to get Emma and Infrahub running together:
4141

4242
```bash
43-
curl https://infrahub.opsmill.io/1.4.12-emma | docker compose -f - up -d
43+
curl https://infrahub.opsmill.io/1.6.2-emma | docker compose -f - up -d
4444
```
4545

4646
Then open [Emma](http://localhost:8501) and [Infrahub](http://localhost:8000) in your browser.
@@ -137,4 +137,4 @@ This documentation covers everything you need to know about Emma. Use the naviga
137137

138138
Emma is designed to make infrastructure management more accessible and efficient. Whether you're modeling a basic network or a complex multi-cloud environment, Emma provides the tools you need to succeed.
139139

140-
Happy infrastructure modeling! 🚀
140+
Happy infrastructure modeling!

docs/docs-emma/reference/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ WARNING: Unknown feature flag 'invalid_flag' ignored
382382

383383
```bash
384384
# Test configuration without starting full application
385-
poetry run python -c "from emma.utils import validate_config; validate_config()"
385+
uv run python -c "from emma.utils import validate_config; validate_config()"
386386
```
387387

388388
## Migration and upgrades
@@ -417,4 +417,4 @@ kubectl get configmap emma-config -o yaml > emma-config-backup.yaml
417417
kubectl get secret emma-secrets -o yaml > emma-secrets-backup.yaml
418418
```
419419

420-
This configuration reference provides comprehensive guidance for setting up Emma in various environments. For troubleshooting configuration issues, see the [Troubleshooting Guide](./troubleshooting).
420+
This configuration reference provides comprehensive guidance for setting up Emma in various environments. For troubleshooting configuration issues, see the [Troubleshooting Guide](./troubleshooting).

docs/docs-emma/reference/feature-flags.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -447,4 +447,4 @@ Emma's experimental features benefit from user feedback:
447447
- **Share use cases** for features you find valuable
448448
- **Contribute documentation** for features you use
449449

450-
Feature flags allow Emma to evolve rapidly while maintaining stability. Use them to access cutting-edge functionality and help shape Emma's future development.
450+
Feature flags allow Emma to evolve rapidly while maintaining stability. Use them to access cutting-edge functionality and help shape Emma's future development.

0 commit comments

Comments
 (0)