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.

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

[#2448] Link to manual from docs #1227

Merged
merged 2 commits into from
Jun 3, 2024
Merged

Conversation

pi-sigma
Copy link
Contributor

Taiga: #2448

@codecov-commenter
Copy link

codecov-commenter commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.22%. Comparing base (9347350) to head (4b6c785).
Report is 37 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1227      +/-   ##
===========================================
+ Coverage    95.21%   95.22%   +0.01%     
===========================================
  Files          968      968              
  Lines        35256    35245      -11     
===========================================
- Hits         33568    33562       -6     
+ Misses        1688     1683       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pi-sigma pi-sigma force-pushed the task/2448-docs-link-manual branch from 883051b to 843ab44 Compare May 29, 2024 13:02
@pi-sigma pi-sigma changed the title Task/2448 docs link manual [#2448] Link to manual from docs May 29, 2024
@pi-sigma pi-sigma marked this pull request as ready for review May 31, 2024 09:42
@pi-sigma pi-sigma requested a review from alextreme May 31, 2024 09:42
Copy link
Member

@alextreme alextreme left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong PDF, it's the manual on https://taiga.maykinmedia.nl/project/open-inwoner/wiki/beheerhandleiding-openinwonerplatform

Note that it is an older version, we should get an update in a week or two.

Lets point to the version on Github from the Taiga wiki once this is moved over

@pi-sigma
Copy link
Contributor Author

@alextreme The task description only specifies a link to the manual. Wouldn't it make sense to provide a link to the Taiga page containing all the docs instead, since the client will also be interested in the document explaining the primary/secondary colors?

@pi-sigma pi-sigma force-pushed the task/2448-docs-link-manual branch from 843ab44 to ee96380 Compare May 31, 2024 14:56
@alextreme
Copy link
Member

@pi-sigma well, the context of the issue is that originally we wanted to have all content of the admin-manual on readthedocs, publically accessible. This is quite a step content-wise as the content needs to be converted to rst/markdown, so publishing the PDF and linking to it was the first quick fix

@pi-sigma
Copy link
Contributor Author

@alextreme Got it. I thought since the manual says "vertrouwelijk" on the title page it should remain behind the Taiga login. I'll put the PDF in the docs folder and update the link.

@alextreme
Copy link
Member

Noted, this is indeed against our security policy. You have approval to publish it, I'll ensure this is noted as a public document for the next iteration

@pi-sigma pi-sigma force-pushed the task/2448-docs-link-manual branch 2 times, most recently from 71226d7 to 4b6c785 Compare May 31, 2024 15:49
@pi-sigma pi-sigma marked this pull request as draft May 31, 2024 16:12
@pi-sigma pi-sigma force-pushed the task/2448-docs-link-manual branch from 4b6c785 to 9423e51 Compare June 3, 2024 08:03
@pi-sigma pi-sigma marked this pull request as ready for review June 3, 2024 08:17
@pi-sigma pi-sigma requested a review from alextreme June 3, 2024 08:17
@alextreme alextreme merged commit 9eea435 into develop Jun 3, 2024
16 checks passed
@alextreme alextreme deleted the task/2448-docs-link-manual branch June 3, 2024 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants