Skip to content

Updated docs and button text #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Wesztman merged 4 commits into from
Mar 12, 2025
Merged

Updated docs and button text #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
726b46a
Update button text from "How to Upload" to only "How to", there is mu…
Wesztman Mar 12, 2025
cd21785
Added required fnutts i.e. " to params in curl command for deletion
Wesztman Mar 12, 2025
e0c3d43
Upgrade cache action from v2 to v4 in lint-and-format workflow
Wesztman Mar 12, 2025
2739ba1
Fix curl command syntax in FAQ for improved clarity and correctness
Wesztman Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/lint-and-format.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
python-version: ${{ matrix.python-version }}

- name: Cache poetry install
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ~/.local
key: poetry-${{ env.POETRY_VERSION }}
Expand All @@ -35,7 +35,7 @@ jobs:

- name: Cache deps
id: cache-deps
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: .venv
key: pydeps-${{ hashFiles('**/poetry.lock') }}
Expand Down
2 changes: 1 addition & 1 deletion byteguide/templates/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
role="button"
href="/faq"
title="Answers to some of common questions..."
style="background-color: hsl(36,100%,50%)">How to Upload</a>
style="background-color: hsl(36,100%,50%)">How to</a>
</li>
</ul>
{% endif %}
Expand Down
10 changes: 5 additions & 5 deletions byteguide/templates/faq.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h5>Delete a version</h5>
<pre>
# Install Azure CLI to get access token, https://learn.microsoft.com/en-us/cli/azure/install-azure-cli
$ ACCESS_TOKEN=$(az account get-access-token --scope a325c352-74f8-48eb-9ca2-3e92712b0fb4/user_impersonation --query accessToken -o tsv)
$ curl -X POST -F project=your-project -F version=your-version -F unique-key=your-unique-key -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/manage/delete
$ curl -X POST -F "project=your-project" -F "version=your-version" -F "unique-key=your-unique-key" -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/manage/delete
</pre>
<b>📢Note:</b> You can also delete ALL versions of a project by passing "version=all" to the above curl command.
</ol>
Expand All @@ -149,7 +149,7 @@ <h5>Delete a project</h5>
<pre>
# Install Azure CLI to get access token, https://learn.microsoft.com/en-us/cli/azure/install-azure-cli
$ ACCESS_TOKEN=$(az account get-access-token --scope a325c352-74f8-48eb-9ca2-3e92712b0fb4/user_impersonation --query accessToken -o tsv)
$ curl -X POST -F project=your-project -F unique-key=your-unique-key -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/manage/delete
$ curl -X POST -F "project=your-project" -F "unique-key=your-unique-key" -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/manage/delete
</pre>
<b>📢Note:</b> You can only delete a project if there are no versions left for that project, use "version=all" from above for a swift kill.
</ol>
Expand Down Expand Up @@ -230,7 +230,7 @@ <h3>FAQ</h3>
if you want to upload a version from your main/master/dev branch such as in the example below:
<pre>
ACCESS_TOKEN=$(az account get-access-token --scope a325c352-74f8-48eb-9ca2-3e92712b0fb4/user_impersonation --query accessToken -o tsv)
curl -X POST -F file=@tests/static/test_docs/Sample-Proj-main.zip -F unique-key=743b92dc-ee45-4671-966a-0e8fa5def464 https://docshost.dev.ctek.com/manage/upload -H "Authorization: Bearer $ACCESS_TOKEN"
curl -X POST -F "file=@tests/static/test_docs/Sample-Proj-main.zip" -F "unique-key=743b92dc-ee45-4671-966a-0e8fa5def464" -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/manage/upload
</pre>
The only requirement is that the version number is unique to your project and alphanumeric.
</p>
Expand All @@ -243,7 +243,7 @@ <h3>FAQ</h3>
For this you can use the `reupload` flag as in the following example:
<pre>
ACCESS_TOKEN=$(az account get-access-token --scope a325c352-74f8-48eb-9ca2-3e92712b0fb4/user_impersonation --query accessToken -o tsv)
curl -X POST -F file=@tests/static/test_docs/Sample-Proj-main.zip -F unique-key=743b92dc-ee45-4671-966a-0e8fa5def464 -F reupload=true https://docshost.dev.ctek.com/manage/upload -H "Authorization: Bearer $ACCESS_TOKEN"
curl -X POST -F "file=@tests/static/test_docs/Sample-Proj-main.zip" -F "unique-key=743b92dc-ee45-4671-966a-0e8fa5def464" -F "reupload=true https://docshost.dev.ctek.com/manage/upload" -H "Authorization: Bearer $ACCESS_TOKEN"
</pre>
Again an example of this would be if you want to upload a version from your main/master/dev branch again and again.
</p>
Expand Down Expand Up @@ -272,7 +272,7 @@ <h3>FAQ</h3>
</pre>
so the final curl command should something like this:
<pre>
curl -X POST -d @register.json -H 'Content-Type: application/json' https://docshost.dev.ctek.com/manage/register -H "Authorization: Bearer $(ACCESS_TOKEN)"
curl -X POST -d @register.json -H "Content-Type: application/json" -H "Authorization: Bearer $(ACCESS_TOKEN)" https://docshost.dev.ctek.com/manage/register
</pre>
</p>
</li>
Expand Down