Skip to content
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

Jump to bottom

Various QoL and code-quality changes #361

Merged
merged 22 commits into from
Dec 15, 2024
Merged

Various QoL and code-quality changes #361

merged 22 commits into from
Dec 15, 2024

Conversation

daringer
Copy link
Contributor

@daringer daringer commented Dec 14, 2024 •
edited
Loading

  • added product-table directive, this allows convenient nitrokey product tables inside nitrokeys/features:
... product-table:: nk3 fido2 hsm
  • added faq directive to increase consistency and semantics for FAQ entries
    • anchors are created from the questions and thus can be used for direct links
    • ensures consistent look&feel across all FAQs (mind the empty line between directive and content)
... faq:: How can I solve my frequent problem?

    Just read this documentation!

  • cleanup main template

    • properly build paths for js-script includes to also work locally
    • avoid running js locally, if it relies on apache2-rewrite-rules
    • breadcrumbs are now also shown locally
    • no more js errors if locally opened

  • footer links for issue creation and edit are linking the correct location

  • migrated all FAQ entries to new directive faq notation

  • migrated all supported-nitrokey-product-tables to new product-table notation

  • ci:

    • many cleanups, especially using python:3.11 as image
    • allow the new directives during rstcheck (+ ignore some messages which are transient due to ignored directives)
    • use new deployment scripts
    • allow preview deployments for each PR
    • include hidden files, needed for .htaccess-based redirects
    • comment with preview url on deployment success

@daringer
add 'product-table' directive
87d619f
@daringer
product-table: enforce build cancel on bad args
eb04d65
@daringer
nk_product_table.py: cleanups
ea5f99c
@daringer
update all sources to use 'product-table' instead of includes
1603393
@daringer
faq_item: add 'faq' directive for better rendering and semantics
538a1e5
@daringer
faq-anchors: switch to directive based creation
e830ee3 
* removed old js-based mechanism to add anchors to FAQ entries
* replace all old-style `**Q:**` faq items with: `.. faq:: <question>``
@daringer
product-table: extension cleanups
798c1c4
@daringer
product-table: various improvements
3ed0352 
* specified order, instead of sorted
* redundant "Nitrokey" now in a single header cell spanning all cols
* add more granular css classes and use them for better visuals
@daringer
local build: enable js-scripts loading locally; disable rewrite depen…
50fe32a 
…dent ones
@daringer
ci: accept new directives during rstcheck
f94e87b
@daringer
ci: use make check for rstcheck; ignore certain messages
8970708
@github-actions GitHub Actions
Copy link

The successful documentation build was deployed for preview:

@github-actions GitHub Actions
Copy link

The successful documentation build was deployed for preview:

@github-actions GitHub Actions
Copy link

The successful documentation build was deployed for preview:

@github-actions GitHub Actions
Copy link

The successful documentation build was deployed for preview:

@github-actions GitHub Actions
Copy link

The successful documentation build was deployed for preview:

@daringer
Copy link
Contributor Author

!

@daringer daringer merged commit b77ea64 into main Dec 15, 2024
2 checks passed
@daringer daringer deleted the add_exts branch December 15, 2024 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@daringer