Feedback: Deploy a Python To-Do App with Flask, Kubernetes, and CockroachDB Cloud
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- flask, kubernetes, python
- Domain
- documentation
Research direction
Open src/current/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md and compare the referenced directory names with the examples-python flask-sqlalchemy directory. Check each occurrence in the deployment walkthrough, then verify that the documented paths match the sample repository and the guide no longer refers to flask-alchemy.
Written by the indexing model from the issue text.
Description
What is the reason for your feedback?
[ ] Missing the information I need
[ ] Too complicated
[ ] Out of date
[x] Something is broken
[ ] Other
Additional details
Hello Team,
In this documentation, the directory name flask-alchemy is used in several places.
However, according to the sample application repository, it seems that the correct directory name is flask-sqlalchemy.
$ git diff
diff --git a/src/current/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md b/src/current/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md
index 30317d885..51a1851a8 100644
--- a/src/current/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md
+++ b/src/current/cockroachcloud/deploy-a-python-to-do-app-with-flask-kubernetes-and-cockroachcloud.md
@@ -132,7 +132,7 @@ ### Step 1. Configure the sample Python app
$ git clone https://github.com/cockroachdb/examples-python
~~~
-1. Navigate to the `flask-alchemy` folder:
+1. Navigate to the `flask-sqlalchemy` folder:
{% include_cached copy-clipboard.html %}
~~~ shell
@@ -218,7 +218,7 @@ ### Step 2. Create a Kubernetes secret
### Step 3. Change certificate directory path in configuration file
-In the `hello.cfg` file in the `flask-alchemy` folder, replace the certificate directory path from the default location to `/data/certs` and save the file.
+In the `hello.cfg` file in the `flask-sqlalchemy` folder, replace the certificate directory path from the default location to `/data/certs` and save the file.
{% include_cached copy-clipboard.html %}
~~~
@@ -276,7 +276,7 @@ ### Step 4. Create a container with the application
### Step 5. Deploy the application
-1. In the `flask-alchemy` folder, create a file named `app-deployment.yaml` and copy the following code into the file. Replace the `{username}` placeholder with the SQL user's username that you created [while preparing the cluster](#step-2-create-a-sql-user):
+1. In the `flask-sqlalchemy` folder, create a file named `app-deployment.yaml` and copy the following code into the file. Replace the `{username}` placeholder with the SQL user's username that you created [while preparing the cluster](#step-2-create-a-sql-user):
{% include_cached copy-clipboard.html %}
~~~
Regards,
Jira issue: DOC-15848
- Dominant language
- HTML
- Stars
- 212
- Forks
- 478
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from cockroachdb/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
cockroachdb/docs#23467 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
cockroachdb/docs#23456 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
cockroachdb/docs#23454 ·
-
Difficulty 2/5 1-2 days Newbie friendliness 68/100
cockroachdb/docs#23445 · 1 comment ·
-
sql-diagram-validation
Difficulty 1/5 Under an hour Newbie friendliness 85/100
cockroachdb/docs#23444 · 4 comments ·
All issues in cockroachdb/docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
alphagov/govuk-frontend-docs#668 ·
Maintainers usually reply within 2 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
bancolombia/scaffold-clean-architecture#1001 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
navikt/esyfo-narmesteleder#615 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 84/100
n8n-io/terraform-aws-n8n#176 ·
Maintainers usually reply within 1 day