Skip to content

Updated faq and added new favicon #21

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 3 commits into from
Nov 26, 2024
Merged

Updated faq and added new favicon #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe570a2
Added more delete info
Wesztman Nov 26, 2024
e5c2620
Updated icon, remove padding
Wesztman Nov 26, 2024
a7e13ae
Added faq on metadata
Wesztman Nov 26, 2024
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
Binary file modified byteguide/static/favicon.ico
View file
Open in desktop
Binary file not shown.
48 changes: 31 additions & 17 deletions byteguide/templates/faq.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ <h5>Upload version to project</h5>
</ol>
</div>

<h3>Delete version</h3>
<h3>Delete version or project</h3>
<h5>Delete a version</h5>
<div>
<ol>
<li>
Expand All @@ -130,10 +131,38 @@ <h3>Delete version</h3>
<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 -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>
</div>
<h5>Delete a project</h5>
<div>
<ol>
<li>
Get the project name.
</li>
<li>
<b>Use the following curl command to delete the project</b>
</li>
<br>
<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
</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>
<h3>Get metadata for a project</h3>
It's possible to read out the metadata for a project using the below curl command. This can be useful if you have lost the unique key for a project.
<br>
<br>
<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 -H "Authorization: Bearer $ACCESS_TOKEN" https://docshost.dev.ctek.com/browse/metadata/your-project

</pre>
<h3>Known Issues</h3>
<div>
<ol>
Expand Down Expand Up @@ -187,21 +216,6 @@ <h3>Known Issues</h3>
</p>
</p>
</li>
<li>
<b>It's not possible to delete whole projects through curl</b>
</b>
<p>
<br>
<b>Reason:</b>
This is not yet implemented.
<br>
<br>
<b>Workaround:</b>
If you really need to delete a whole project, please contact the site admin which have access to the hosting server.
<br>
Note: Version deletion is possible through curl.
</p>
</li>
</ol>
</div>
<h3>FAQ</h3>
Expand Down
Loading