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

Document RSS Feed Author #2341

Closed
c-git opened this issue Oct 28, 2023 · 4 comments
Closed

Document RSS Feed Author #2341

c-git opened this issue Oct 28, 2023 · 4 comments

Comments

@c-git
Copy link
Contributor

c-git commented Oct 28, 2023

Documentation issue

Summary

What is the issue? Is the documentation unclear? Is it missing information?

I'm trying to set the author in the rss feed and the can't seem to find how to do it in the documentation.

Proposed solution

A quick explanation of what you would like to see to solve the issue.
If you want to add content, please explain what you were looking for
and what was your process while looking at the current documentation.

I'd like to see the steps required to set the author documented and easy to find.

I checked the page documenting feeds and didn't find it. Then I did a search on the documentation using the search at the top for the word "author" but only turned up results that appear to be for themes. Thus I came to the conclusion this is not documented yet.

At this point I'm mostly checking if that is the case before I try to create a PR to document it. Of corse if it does already exist please pardon my ignorance and point me in the right direction.

I am lead to believe that it does exist due to this issue and this PR and observing that the author is set to Unknown in the currently output feed and not empty.

I think if it goes in the extra section of the config and front matter then those would be the best places to document it by showing it with the default value and a comment explaining what it is (Like the rest of the documentation). And then a mention of it on the feed page. Possibly with a short summary, while the repetition would make it easier to find, it would cause more work to update if it changes in the future as more places would need to be updated, leading to possibly inconsistent documentation.

If it should be or is documented somewhere else please let me know.

@Keats
Copy link
Collaborator

Keats commented Oct 29, 2023

It should be documented yes. it looks ups in order: front-matter, config or default to unknown

@c-git
Copy link
Contributor Author

c-git commented Oct 29, 2023

Thanks going to give it a try now. Cuz was just going to update my site.

@c-git
Copy link
Contributor Author

c-git commented Oct 29, 2023

Turns out it is already documented for the front matter but I guess this is not included in the search index I didn't see it in the results. Have to run now will finish later this evening hopefully.

@c-git c-git mentioned this issue Oct 30, 2023
1 task
@c-git
Copy link
Contributor Author

c-git commented Oct 31, 2023

Documentation merged

@c-git c-git closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants