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

add quick reference for actions #658

Closed
wants to merge 17 commits into from

Conversation

ralfbrown
Copy link
Contributor

Start of a "how to" section to point users at modules for accomplishing specific tasks.

@elstoc
Copy link
Contributor

elstoc commented Jun 22, 2024

I think this is generally a good idea, but will need some thought before I decide to merge. A few minor points in the meantime...

  • I won't merge this until all of the modules it references have been documented
  • This maybe belongs in the guides/tutorials section
  • Will need to consider structure, especially if we think this will grow in the future. For example, we might want to consider combining a few of these on a single page and perhaps categorise them somehow
  • Probably should be linked from the Overview section
  • Section headers mostly use lowercase in the user manual, and these sections should too

@ralfbrown
Copy link
Contributor Author

I expect that a lot of the entries will be like hsl.md, just one sentence with a link to the relevant module. The longer ones like sky replacement might indeed fit better under tutorials, though what I had in mind was a quick reference rather than detailed instructions.

I think we should avoid combining too many things, or people will have trouble finding what they want because it's under some umbrella term in the section's index.

I realized right after pushing that I had automatically capitalized the section headers. Will fix when revising, once the overall direction is decided.

Copy link

This pull request has not had any activity in the past 60 days and will be closed in 365 days if not updated. Please verify it has no conflicts with the master branch and rebase if needed. Please add a comment if you need help or give permission to other people to finish your work.

@github-actions github-actions bot added the no-pr-activity No activity on this PR label Sep 23, 2024
@elstoc
Copy link
Contributor

elstoc commented Dec 12, 2024

Just a heads-up on this one... As time goes on I'm less and less convinced we want to do this. Maintenance of this repo is already nobody's top priority and I think this repeats too much information that's available elsewhere.

I think we might need to just concentrate on the absolute minimum required for reference purposes and scale back on big changes like this.

If you're really set on publishing something like this, it might be better as a pixls article or a blog post on dtorg?

@ralfbrown
Copy link
Contributor Author

ralfbrown commented Dec 12, 2024

My gut preference was for a dtorg blog post, and when I looked at the repo I saw that posts are set up the same way as the documentation, which makes the conversion easier. Do you know if the dtorg blog posts allow nested pages? (That would make the conversion triival.) Second choice would be if there's markdown syntax to generate <details> tags for collapsible sections, or if any explictly-written ones are preserved. Last choice would be a list of links to in-page anchors. I don't think having a completely flat article would be very useful, as it makes quick lookup of specific actions/effects of interest much slower.

@elstoc
Copy link
Contributor

elstoc commented Dec 12, 2024

The only thing I can suggest is to try it out and see what you can do. The dtorg site also uses hugo under-the-hood, though links probably work differently (we have a custom link conversion in place on dtdocs). It should be fairly easy to set up locally and play, and you could drop into the darktable IRC channel for a chat if you get stuck, as there might be something we could do to make it easier.

The obvious advantages of a dtorg post or some sort of article are

(a) It's a one-off and doesn't need ongoing maintenance
(b) It is a post specifically by you, which means we would treat it as "opinion" rather than "official by the darktable team", which means I wouldn't feel the need to do so much checking for factual accuracy (which is often what stops me being able to approve dtdocs stuff)

@github-actions github-actions bot removed the no-pr-activity No activity on this PR label Dec 13, 2024
@ralfbrown
Copy link
Contributor Author

See darktable-org/dtorg#260

@ralfbrown ralfbrown closed this Dec 16, 2024
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.

2 participants