You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Here are some key observations to aid the review process:
⏱️ Estimated effort to review: 5 🔵🔵🔵🔵🔵
🧪 No relevant tests
🔒 Security concerns
Sensitive information exposure: The documentation includes hardcoded sensitive information such as passwords and API secrets in example configurations. These should be replaced with placeholders or instructions to use secure methods for managing sensitive data.
The example configurations in the installation guide include hardcoded sensitive information such as database passwords (secr3t, sup3rsecr3t) and API secrets. Ensure these are replaced with placeholders or environment variables to prevent accidental exposure.
-- Creating userCREATE USER admin WITH ENCRYPTED PASSWORD 'secr3t';CREATE DATABASE portal;GRANT ALL PRIVILEGES ON DATABASE portal TO admin;```3.**Create the database volume and launch the database**
The next step is to launch the PostgreSQL database for the portal. To achieve this, create a data volume for the database first:
```console docker volume create tyk-portal-postgres-data
```
Then launch the PostgreSQL instance by executing the following command: ```container docker run \ -d \ --name tyk-portal-postgres \ --restart on-failure:5 \ -e POSTGRES_PASSWORD=secr3t \ -e PGDATA=/var/lib/postgresql/data/pgdata \ --mount type=volume,source=tyk-portal-postgres-data,target=/var/lib/postgresql/data/pgdata \ --mount type=bind,src=$(pwd)/init.sql,dst=/docker-entrypoint-initdb.d/init.sql \ --network tyk-portal \
The documentation mentions SQLite support, which is deprecated as of Tyk 5.7.0. Ensure this is clearly communicated and alternative options are emphasized to avoid confusion for users.
SQLite support will be deprecated from Tyk 5.7.0. To avoid disrupution, please transition to PostgreSQL, MongoDB or one of the listed compatible alternatives.
{{< /note >}}
The Docker Compose instructions contain duplicate commands for launching and cleaning up containers. This redundancy may confuse users and should be streamlined.
docker-compose --env-file .env up -d
docker-compose --env-file .env up -d
Why: The suggestion improves the configuration by setting a value for refLinksNotFoundURL, which ensures that broken links in the documentation are handled gracefully by redirecting users to a 404 page. This enhances user experience and prevents confusion caused by unresolved links.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/overview/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/install/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/developers/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/api-access/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/customization/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/portal/settings/
https://deploy-preview-5863--tyk-docs.netlify.app/docs/nightly/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api/
Description
Screenshots (if appropriate)
Checklist
master.PR Type
Documentation
Description
Added comprehensive installation guide for Tyk Enterprise Developer Portal.
Introduced detailed API consumer management documentation.
Enhanced FAQ section with Enterprise Developer Portal-specific questions.
Updated configuration settings for improved reference linking.
Changes walkthrough 📝
3 files
Added detailed installation guide for Tyk Enterprise Developer Portal.Added API consumer management and registration documentation.Enhanced FAQ with Enterprise Developer Portal-specific questions.1 files
Updated configuration for reference linking and error handling.58 files