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

usermanual : iop layouts #6576

Merged
merged 3 commits into from
Oct 21, 2020
Merged

Conversation

AlicVB
Copy link
Contributor

@AlicVB AlicVB commented Oct 19, 2020

Documentation for the new iop layout presets/manager

Keep in mind that I'm not really good at writing English, so proofreading is needed here ;)

@AlicVB AlicVB added the scope: usermanual improving the documentation label Oct 19, 2020
@AlicVB AlicVB added this to the 3.4 milestone Oct 19, 2020
@AlicVB AlicVB linked an issue Oct 19, 2020 that may be closed by this pull request
@TurboGit
Copy link
Member

@AlicVB : I'll review, I'm not terrible in English either, but you may know that there is an ongoing project to rework the whole dt documentation. So at the end it does not matter too much :)

@AlicVB
Copy link
Contributor Author

AlicVB commented Oct 19, 2020

Ok, I've also completely reordered the modules part to present them like the default preset.
Not too much to proofread, but maybe some double-check needed, to verify I've not missed or inverted something ;)

When doing this work, I've found that basic adjustments isn't described... @TurboGit : should I open an issue for that ?

@AlicVB
Copy link
Contributor Author

AlicVB commented Oct 19, 2020

a note for @aurelienpierre and any other proofreader :
the description of the three groups are copy-paste from PR #5322 . Maybe we should enhance them a bit, especially for the third one ?

@TurboGit
Copy link
Member

When doing this work, I've found that basic adjustments isn't described... @TurboGit : should I open an issue for that ?

Yes please !

@@ -1,35 +1,44 @@
<sect2 status="final" id="effect_group">
<sect2 status="final" id="effects_group">
Copy link
Member

Choose a reason for hiding this comment

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

Don't we need to update the integrated help (when clicking on ?) as links have changed? Probably true for many other changes here I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oh... forgot that... But yes, there should be many links to change (at least all the iops...) I'll have a look !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm... so it seems I have tons of links to change in usermanual_url.c (basically each iop link as changed)
problem : once they are changed, they will point to invalid urls until we release the manual... should I do this anyway ? or should we postponed it ?

Copy link
Member

Choose a reason for hiding this comment

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

I would say no big deal. The current master is for advanced users who don't need the help I suppose or can live without it for some time. And I do plan to publish the 3.4 manual at the same time as the release this year.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done. and in the same time I've fixed lot of invalid urls or missing ones. Surprising that no user raise issues... Maybe a sign that this feature is underutilized ?

Copy link
Member

@TurboGit TurboGit left a comment

Choose a reason for hiding this comment

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

Good to me, thanks !

@TurboGit TurboGit merged commit dfc991d into darktable-org:master Oct 21, 2020
@TurboGit TurboGit added this to done in documentation Oct 21, 2020
@AlicVB AlicVB deleted the docs_iop_layouts branch December 15, 2021 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: usermanual improving the documentation
Projects
Development

Successfully merging this pull request may close these issues.

documentation: new module group
2 participants