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

Some wrong setting link texts #1008

Closed
sirainen opened this issue Sep 4, 2024 · 4 comments · Fixed by #1021
Closed

Some wrong setting link texts #1008

sirainen opened this issue Sep 4, 2024 · 4 comments · Fixed by #1021

Comments

@sirainen
Copy link
Contributor

sirainen commented Sep 4, 2024

These setting links try to link to a setting with a specific text, but intead they end up having "setting name = text" while only "text" was intended. Is there a way to fix these?

docs/core/admin/guides/spam_reporting.md:[[setting,sieve_>extension<_bin_dir,sieve_pipe_bin_dir]]. You
docs/core/config/auth/userdb.md:[[setting,namespace/separator,namespace/default/separator]] extra field.
docs/installation/upgrade/include/2.3-to-2.3.x.inc:  [[setting,namespace/mailbox/auto,mailbox { auto }]] instead.
docs/installation/upgrade/include/2.3-to-2.3.x.inc:  [[setting,namespace/mailbox/autoexpunge,mailbox { autoexpunge }]] instead.

And in Pro docs:

docs/plugins/virtual_attachments.md:[[setting,namespace/mailbox/auto,auto-created]].
@slusarz
Copy link
Contributor

slusarz commented Sep 4, 2024

That's currently the expected behavior. See https://github.com/dovecot/documentation/tree/main?tab=readme-ov-file#settings

@sirainen
Copy link
Contributor Author

sirainen commented Sep 4, 2024

Yeah, expected perhaps, but not wanted behavior in these cases, since it just looks wrong. Could we maybe add 4th parameter like [[setting,key,,text]] and it just creates a link to key with text as the link.

@slusarz
Copy link
Contributor

slusarz commented Sep 4, 2024

That's probably the only way of doing it. I was thinking of maybe creating a separate markdown link item that is essentially an alias of setting, that would have different output display semantics, but that's probably even more confusing.

slusarz added a commit to slusarz/dovecot-documentation that referenced this issue Sep 16, 2024
@slusarz
Copy link
Contributor

slusarz commented Sep 16, 2024

Added setting_text markdown command to handle the situation where you want link to be specific text.

slusarz added a commit to slusarz/dovecot-documentation that referenced this issue Sep 16, 2024
sirainen pushed a commit that referenced this issue Sep 17, 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 a pull request may close this issue.

2 participants