Skip to content

Commit 4d991c4

Browse files
authored
Merge pull request #154 from deploystackio/fix/links
docs: update links in documentation to reflect new directory structur…
2 parents fe700a4 + f541275 commit 4d991c4

13 files changed

Lines changed: 41 additions & 36 deletions

docs/deploystack/development/frontend/index.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,6 @@ Continue reading the detailed guides:
344344
- [Internationalization (i18n)](/deploystack/development/frontend/internationalization) - Multi-language support
345345
- [Plugin System](/deploystack/development/frontend/plugins) - Extending functionality
346346
- [Router Optimization](/deploystack/development/frontend/router-optimization) - Performance improvements
347-
- [Contributing Guidelines](/deploystack/development/frontend/contributing) - How to contribute
348347

349348
## Docker Development
350349

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Troubleshooting DeployStack
3+
description: Common issues and solutions for DeployStack MCP Serverdeployments
4+
sidebar: Troubleshooting
5+
---
6+
7+
# Troubleshooting DeployStack
8+
9+
Under this section, we will cover common issues and solutions for DeployStack MCP Server deployments. If you encounter any problems, please refer to the following troubleshooting steps.

docs/docker-deployment/application-logo-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Add a custom logo to make your application stand out in the DeployStack catalog.
99

1010
## Adding Your Logo
1111

12-
Configure your logo in `.deploystack/config.yml` - [DeployStack Configuration File Reference](/deploystack/deploystack-config-file):
12+
Configure your logo in `.deploystack/config.yml` - [DeployStack Configuration File Reference](/docker-deployment/deploystack-config-file):
1313

1414
```yaml
1515
application:

docs/docker-deployment/deploystack-config-file.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The override process follows this order:
5656

5757
### Branch Deployment Settings
5858

59-
Before configuring multiple branch deployments, ensure you have installed the [DeployStack Repository Sync GitHub App](/deploystack/github-application), as it's required for branch monitoring and template updates.
59+
Before configuring multiple branch deployments, ensure you have installed the [DeployStack Repository Sync GitHub App](/docker-deployment/github-application), as it's required for branch monitoring and template updates.
6060

6161
You can configure multiple branch deployments using the `deployment.branches` section:
6262

@@ -256,4 +256,4 @@ deployment:
256256

257257
### Minimal Configuration example for logo update
258258

259-
Please visit our [Application Logo Configuration](/deploystack/application-logo-configuration) page.
259+
Please visit our [Application Logo Configuration](/docker-deployment/application-logo-configuration) page.

docs/docker-deployment/deploystack-configuration-directory.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Technical guide for setting up the .deploystack directory to manage
55

66
# .deploystack Directory Reference
77

8-
The `.deploystack` directory in your repository contains configuration files that DeployStack uses to generate and maintain your Infrastructure as Code templates. Creating this repo allows you to enable the [lifecycle of IaC](/deploystack/iac-lifecycle). The deploystack configurations repo only makes sense if you also [install DeployStack GitHub app](/deploystack/github-application). Otherwise, changes to DeployStack backend will not be recognized.
8+
The `.deploystack` directory in your repository contains configuration files that DeployStack uses to generate and maintain your Infrastructure as Code templates. Creating this repo allows you to enable the [lifecycle of IaC](/docker-deployment/iac-lifecycle). The deploystack configurations repo only makes sense if you also [install DeployStack GitHub app](/docker-deployment/github-application). Otherwise, changes to DeployStack backend will not be recognized.
99

1010
<Callout>
1111
`.deploystack` directory is optional. You don't need to create it to submit your repository to deploystack.io.
@@ -24,7 +24,7 @@ The `.deploystack` directory in your repository contains configuration files tha
2424

2525
### DeployStack Configuration File
2626

27-
Please read more at [DeployStack Configuration File Reference](/deploystack/deploystack-config-file).
27+
Please read more at [DeployStack Configuration File Reference](/docker-deployment/deploystack-config-file).
2828

2929
### Docker Configuration
3030

@@ -52,11 +52,11 @@ docker run -d -p 80:80 nginx:alpine
5252

5353
### Environment Variables
5454

55-
Please read more from our [environment variables](/deploystack/docker-environment-variables) page.
55+
Please read more from our [environment variables](/docker-deployment/docker-environment-variables) page.
5656

5757
## Automatic Updates
5858

59-
When the [DeployStack GitHub App](/deploystack/github-application) is installed:
59+
When the [DeployStack GitHub App](/docker-deployment/github-application) is installed:
6060

6161
1. Changes to specific (`docker-compose.yml` & `docker-run.txt`) file in `.deploystack/` trigger template updates
6262
2. Updates only process when changes occur on the default branch
@@ -66,6 +66,6 @@ When the [DeployStack GitHub App](/deploystack/github-application) is installed:
6666

6767
- The `.deploystack` directory is **optional**
6868
- Without this directory, automatic template updates are **not** available
69-
- You can add the directory and install the [DeployStack GitHub Sync App](/deploystack/github-application) at any time
70-
- [Environment variables](/deploystack/docker-environment-variables) and [DeployStack config](/deploystack/deploystack-config-file) are optional components
69+
- You can add the directory and install the [DeployStack GitHub Sync App](/docker-deployment/github-application) at any time
70+
- [Environment variables](/docker-deployment/docker-environment-variables) and [DeployStack config](/docker-deployment/deploystack-config-file) are optional components
7171
- Only one Docker configuration file should be used (either compose or run)

docs/docker-deployment/docker-compose-requirements.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Currently, DeployStack only supports public images from Docker Hub. If you need
8686

8787
## Environment Variables
8888

89-
Please read more from our [environment variables](/deploystack/docker-environment-variables) page.
89+
Please read more from our [environment variables](/docker-deployment/docker-environment-variables) page.
9090

9191
## Validation
9292

@@ -98,5 +98,5 @@ When you submit your repository, we perform these checks:
9898

9999
## Next Steps
100100

101-
- See how [One-Click Deploy](/deploystack/one-click-deploy) works
102-
- Check the [Troubleshooting](/deploystack/troubleshooting) guide if you run into issues
101+
- See how [One-Click Deploy](/docker-deployment/one-click-deploy) works
102+
- Check the [Troubleshooting](/docker-deployment/troubleshooting) guide if you run into issues

docs/docker-deployment/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Create a `.deploystack` directory in your repository with these components:
101101
- `docker-run.txt`: Alternative to compose file, contains your Docker run command
102102
- Only one of these files should be present
103103

104-
For more configuration options please check our [.deploystack Directory Reference](/deploystack/deploystack-configuration-directory).
104+
For more configuration options please check our [.deploystack Directory Reference](/docker-deployment/deploystack-configuration-directory).
105105

106106
### GitHub App Integration
107107

@@ -191,6 +191,6 @@ After template generation:
191191

192192
## Need Additional Help?
193193

194-
- Review our detailed [Troubleshooting Guide](/deploystack/troubleshooting)
194+
- Review our detailed [Troubleshooting Guide](/docker-deployment/troubleshooting)
195195
- Join our active [Discord Community](https://discord.gg/UjFWwByB)
196196
- Submit issues on GitHub to our [Feedback repository](https://github.com/deploystackio/feedback)

docs/docker-deployment/github-application.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The DeployStack GitHub App ensures your Infrastructure as Code (IaC) templates r
1111

1212
When you install the [DeployStack Repository Sync](https://github.com/apps/deploystack-repository-sync) app, it monitors specific files in your repository:
1313

14-
- `.deploystack/` directory - [Contains your Docker configurations and assets](/deploystack/deploystack-configuration-directory)
14+
- `.deploystack/` directory - [Contains your Docker configurations and assets](/docker-deployment/deploystack-configuration-directory)
1515
- `README.md` - For README.md updates
1616

1717
When changes are detected in these files, the app automatically triggers an update of your IaC templates in our [deploy-templates](https://github.com/deploystackio/deploy-templates) repository.
@@ -47,12 +47,12 @@ When the app detects changes, it automatically updates:
4747
- Repository Homepage
4848
- Description
4949
- IaC templates
50-
- Depends on which technique (docker compose or docker run command) you choose, you can upload the `docker-compose.yml` or `docker-run.txt` in the `.deploystack` directory. Every time you update the files on your main branch (or additional branch), IaC templates will be updated automatically - [Automatic Updates](/deploystack/deploystack-configuration-directory#automatic-updates).
50+
- Depends on which technique (docker compose or docker run command) you choose, you can upload the `docker-compose.yml` or `docker-run.txt` in the `.deploystack` directory. Every time you update the files on your main branch (or additional branch), IaC templates will be updated automatically - [Automatic Updates](/docker-deployment/deploystack-configuration-directory#automatic-updates).
5151
- Environment variables
52-
- To make it easier for a user to deploy IaC templates, it is recommended to work with environment variables. For this purpose, you can upload an `env` file and add your appropriate variables - [Environment Variables](/deploystack/deploystack-configuration-directory#environment-variables).
52+
- To make it easier for a user to deploy IaC templates, it is recommended to work with environment variables. For this purpose, you can upload an `env` file and add your appropriate variables - [Environment Variables](/docker-deployment/deploystack-configuration-directory#environment-variables).
5353
- DeployStack Configuration
5454
- Project / Applicaton Logo
55-
- It is possible to upload your own logo to DeployStack catalog. To do this you need to upload a file to our directory `.deploystack`. Read more about it here: [Repository Logo](/deploystack/deploystack-configuration-directory#repository-logo)
55+
- It is possible to upload your own logo to DeployStack catalog. To do this you need to upload a file to our directory `.deploystack`. Read more about it here: [Repository Logo](/docker-deployment/deploystack-configuration-directory#repository-logo)
5656

5757
## Managing the Integration
5858

@@ -66,4 +66,4 @@ After installing the app:
6666
2. Commit and push your changes
6767
3. DeployStack will automatically update your deployment templates
6868

69-
For details about the `.deploystack` directory structure, check our [.deploystack Directory Reference](/deploystack/deploystack-configuration-directory).
69+
For details about the `.deploystack` directory structure, check our [.deploystack Directory Reference](/docker-deployment/deploystack-configuration-directory).

docs/docker-deployment/iac-lifecycle.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This guide explains how DeployStack manages and updates your Infrastructure as C
1111

1212
### Initial Setup
1313

14-
1. Create a `.deploystack` [configuration directory](/deploystack/deploystack-configuration-directory) in your repository
14+
1. Create a `.deploystack` [configuration directory](/docker-deployment/deploystack-configuration-directory) in your repository
1515
2. Add your Docker configuration files:
1616
- `docker-compose.yml` for Compose configurations
1717
- `docker-run.txt` for Docker run commands
@@ -20,7 +20,7 @@ This guide explains how DeployStack manages and updates your Infrastructure as C
2020

2121
### Enabling Automatic Updates
2222

23-
Install the [DeployStack Repository Sync](/deploystack/github-application) GitHub App to keep your templates up to date when:
23+
Install the [DeployStack Repository Sync](/docker-deployment/github-application) GitHub App to keep your templates up to date when:
2424

2525
- You modify Docker configurations in the `.deploystack` directory
2626
- Cloud providers update their IaC specifications
@@ -36,7 +36,7 @@ All IaC templates are stored in public and open-source repository: [https://gith
3636

3737
### Prerequisites for activating the flow
3838

39-
1. You have installed the [DeployStack GitHub app](/deploystack/github-application).
39+
1. You have installed the [DeployStack GitHub app](/docker-deployment/github-application).
4040
2. You have created the `.deploystack/docker-run.txt` or `.deploystack/docker-compose.yml` file.
4141

4242
The choice between `docker-run.txt` or `docker-compose.yml` depends on the submission process used to DeployStack. When submitting to DeployStack, you can choose two methods -> Docker Run or Docker Compose.

docs/docker-deployment/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ DeployStack helps you deploy Docker Compose and Docker Run applications across d
1010

1111
## Documentation Sections
1212

13-
- [Getting Started](/deploystack/getting-started) - Quick introduction and first steps
14-
- [Docker Compose Requirements](/deploystack/docker-compose-requirements) - Learn about supported configurations
15-
- [One-Click Deploy](/deploystack/one-click-deploy) - Learn about deployment automation
16-
- [Troubleshooting](/deploystack/troubleshooting) - Resolve common issues
13+
- [Getting Started](/docker-deployment/getting-started) - Quick introduction and first steps
14+
- [Docker Compose Requirements](/docker-deployment/docker-compose-requirements) - Learn about supported configurations
15+
- [One-Click Deploy](/docker-deployment/one-click-deploy) - Learn about deployment automation
16+
- [Troubleshooting](/docker-deployment/troubleshooting) - Resolve common issues
1717

1818
## Additional Resources
1919

0 commit comments

Comments
 (0)