docs icon indicating copy to clipboard operation
docs copied to clipboard

document that `atom` feeds are available for things and explain how to access them

Open jsoref opened this issue 6 months ago • 32 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

What part(s) of the article would you like to see updated?

Add a page or sections to pages that talk about which things have atom feeds and the urls to access them

Additional information

I searched through all 4 pages of https://docs.github.com/en/search?query=feed and nothing turned up to tell me how to get an atom feed for releases.

there's a reference in https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes to a "releases" "feed', but it's effectively https://github.com/home-assistant/core/releases and not https://github.com/home-assistant/core/releases.atom

jsoref avatar May 20 '25 14:05 jsoref

Thanks for opening an issue! I'll get it triaged for review.

Sharra-writes avatar May 20 '25 19:05 Sharra-writes

@jsoref Sooo...I talked to the team and apparently Atom is at the end of its life and is supposed to be deprecated. In fact, my searching for it turned up a bunch of references that I'm told need to be removed. 😅 Sorry about this one. I'm afraid the opposite is happening.

Sharra-writes avatar May 23 '25 15:05 Sharra-writes

@Sharra-writes : To be clear, I'm talking about Atom ~ RSS, not Atom ~ VSCode

jsoref avatar May 23 '25 16:05 jsoref

@jsoref I'll double check just to be sure we were all talking about the same thing.

Sharra-writes avatar May 23 '25 16:05 Sharra-writes

@jsoref We were not all talking about the same thing. Time to do more digging.

Sharra-writes avatar May 23 '25 16:05 Sharra-writes

I'm having trouble finding someone who knows anything about Atom (still looking), but one of the team wondered if this blog post would help you at all.

Sharra-writes avatar May 28 '25 18:05 Sharra-writes

@Sharra-writes: nope, that says I can ask about certain private feeds. I want to know that even if I am not a member of the github organization (and I'm not) that I can request: https://github.com/github.atom

The docs say:

User: The public timeline for any user, using uri_template. For more information, see "Hypermedia." Current user organizations: The private timeline for the organizations the authenticated user is a member of.

But, users are not organizations (nor are they enterprises), and this makes no mention of organizations the user isn't a member of.

There might be repository feeds too, but I have an even harder time figuring out how to make any statement about them.

jsoref avatar May 28 '25 19:05 jsoref

@jsoref Okay, sorry that doesn't help. I got a name for someone who's been here a long time and might know about it, or at least know who to ask, so 🤞

Sharra-writes avatar May 28 '25 19:05 Sharra-writes

@jsoref I am back from my digging. Here is what I've been informed: Atom feeds are intentionally undocumented and unsupported, as we generally encourage folks to use our REST | GraphQL API instead (for reasons like performance, scalability, and long-term supportability). I linked your comment about whether you can request https://github.com/github.atom, but no one gave me a direct answer on that question, so I've asked more directly if that's something we have an answer for, and I'll update you with what I find out.

Sharra-writes avatar Jun 03 '25 19:06 Sharra-writes

很抱歉我原本是完全沒接觸過的新手 用不到兩個月 這個是我無中生有製造的我正在慢慢回復跟修改 給我點時間

Sharra-writes @.***>於 2025年6月4日 週三,上午3:28寫道:

Sharra-writes left a comment (github/docs#38439) https://github.com/github/docs/issues/38439#issuecomment-2936837334

@jsoref https://github.com/jsoref I am back from my digging. Here is what I've been informed: Atom feeds are intentionally undocumented and unsupported, as we generally encourage folks to use our REST | GraphQL API instead (for reasons like performance, scalability, and long-term supportability). I linked your comment about whether you can request https://github.com/github.atom, but no one gave me a direct answer on that question, so I've asked more directly if that's something we have an answer for, and I'll update you with what I find out.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/38439#issuecomment-2936837334, or unsubscribe https://github.com/notifications/unsubscribe-auth/BSWC2ATPZE6SIYTG2F5IJYT3BXZNZAVCNFSM6AAAAAB5QVS5HSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSMZWHAZTOMZTGQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

cceneag avatar Jun 03 '25 21:06 cceneag

@jsoref Answer is: yes, you can make that request and it will show you public activity.

Sharra-writes avatar Jun 03 '25 22:06 Sharra-writes

@Sharra-writes, great, are they opposed to documenting that too?

It seems incredibly unlikely that it'd be removed as there's a private version for members which is documented...

jsoref avatar Jun 03 '25 22:06 jsoref

不能都安排嗎? 請問每個參賽者的選項都一樣嗎!? 我不能兩種都學習嗎?

不好意思想另外請問一般工程師的工作跟我明白操作的這些差不多嗎?現在科技這麼進步還有python,ai的部分沒有發表創作就沒辦法賺錢嗎?

Josh Soref @.***>於 2025年6月4日 週三,上午6:44寫道:

jsoref left a comment (github/docs#38439) https://github.com/github/docs/issues/38439#issuecomment-2937532482

@Sharra-writes https://github.com/Sharra-writes, great, are they opposed to documenting that too?

It seems incredibly unlikely that it'd be removed as there's a private version for members which is documented...

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/38439#issuecomment-2937532482, or unsubscribe https://github.com/notifications/unsubscribe-auth/BSWC2AS6PIO7EDVRRSLZLXD3BYQLJAVCNFSM6AAAAAB5QVS5HSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDSMZXGUZTENBYGI . You are receiving this because you commented.Message ID: @.***>

cceneag avatar Jun 03 '25 22:06 cceneag

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-your-organizations-news-feed https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

What part(s) of the article would you like to see updated?

Add a page or sections to pages that talk about which things have atom feeds and the urls to access them

Additional information

I searched through all 4 pages of https://docs.github.com/en/search?query=feed and nothing turned up to tell me how to get an atom feed for releases.

there's a reference in https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes to a "releases" "feed', but it's effectively https://github.com/home-assistant/core/releases and not https://github.com/home-assistant/core/releases.atom

Zohrejooon avatar Jun 04 '25 03:06 Zohrejooon

@jsoref Honestly? There seems to be a lot of reluctance to touch the subject. Docs isn't really responsible for broad policy decisions like that, that's more on the engineering/platform health side, so figuring it out would be a negotiation that I don't think anyone has the bandwidth for, especially right now. We're dealing with a pretty significant uptick in spam, which I hope hasn't been bad enough for contributors to notice, but probably has. I definitely wish I weren't noticing it, but that's my job.

Sharra-writes avatar Jun 04 '25 17:06 Sharra-writes

Oh, I've definitely noticed the spam in this repository.

I really don't understand why github supports replying to email and certainly don't know why it supports responding to email for this repository.

jsoref avatar Jun 04 '25 17:06 jsoref

@jsoref I'm sure it had, maybe still has, a purpose, but I don't know what the reasoning was and certainly wouldn't mind if someone revisited the decision and came down on the side of "not worth it."

Sharra-writes avatar Jun 04 '25 17:06 Sharra-writes

That seems like a more valuable thing to fight (getting rid of email inbound, if only for this repo) for than what I'm asking for here...

examples of people struggling with that feature
  • https://github.com/orgs/community/discussions/77491
  • https://bettersoftwaresuggestions.com/github/help-me-have-a-clean-message-when-replying-to-an-issue-via-email/
  • https://github.com/pta2002/typst-timeliney/issues/16#issuecomment-2784780141

I understand the imagined convenience for plain text email clients using English, but the majority of users fall into at least one of these buckets:

  • they don't use plain text email (which breaks parsing)
  • they don't use English for their plain text email client (which breaks parsing)
  • they don't write English in their email client (which is probably also a problem since a portion of the email they're replying to is probably going to be in English (GitHub is not available in your language))

jsoref avatar Jun 04 '25 22:06 jsoref

@jsoref I actually did mention it to my manager, she went combing through the repo settings she has available, and it's not an option available to her. She's going to look into it more and see if she can move it up the chain, but it's apparently a decision above both our pay grades.

Sharra-writes avatar Jun 04 '25 22:06 Sharra-writes

👍

cceneag avatar Jun 07 '25 07:06 cceneag

A stale label has been added to this issue and it has been closed, because it has been open for 30 days with no activity. If you think this issue should remain open, please add a new comment.

github-actions[bot] avatar Jul 10 '25 16:07 github-actions[bot]

@Sharra-writes

jsoref avatar Jul 10 '25 16:07 jsoref

@jsoref Well, that's lovely. We're having a GraphQL problem of some sort that's slowly taking away my ability to do things in issues. I stopped getting notifications about new ones last week, and now I'm apparently not getting state change notifications. I actually am going to ask if we can disable the stale workflow until the GraphQL thing is sorted out, because this is ridiculous.

Sharra-writes avatar Jul 10 '25 18:07 Sharra-writes

A stale label has been added to this issue, because it has been open for 30 days with no activity. If you think this issue should remain open, please add a new comment.

github-actions[bot] avatar Aug 12 '25 16:08 github-actions[bot]

docs: add documentation for Atom feeds and how to access them

  • Explain availability of Atom feeds across GitHub (issues, commits, releases, discussions, user activity)
  • Provide examples of .atom URLs
  • Add guidance for using feeds in external readers

kumariaditi52 avatar Aug 19 '25 14:08 kumariaditi52

make a shorter version (just title + closes)

kumariaditi52 avatar Aug 19 '25 14:08 kumariaditi52

Any news on finding someone who knows what this was @Sharra-writes ? One scenario i think where this would be useful is following specific files in a repo. I'd like to be able to subscribe to a feed of https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md for example so i can read it in my RSS reader (feedly) alongside other news items like blog posts etc. I did find this Reddit post - not quite what i need, but shows some of the options.

mnbf9rca avatar Aug 22 '25 15:08 mnbf9rca

@mnbf9rca The only response I've received is that it's intentionally undocumented. The exact quote was, "Atom feeds are intentionally undocumented and unsupported, as we generally encourage folks to use our REST | GraphQL API instead (for reasons like performance, scalability, and long-term supportability)." I don't use Atom or know how it works, so "how" might be a good discussion question for the community, but you should be able to subscribe to whatever you want.

Sharra-writes avatar Aug 22 '25 16:08 Sharra-writes

A stale label has been added to this issue, because it has been open for 30 days with no activity. If you think this issue should remain open, please add a new comment.

github-actions[bot] avatar Sep 30 '25 16:09 github-actions[bot]

I'd like to be able to subscribe to a feed of https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md for example

There is a feed of changes to that file; click History then append .atom:

https://github.com/anthropics/claude-code/commits/main/CHANGELOG.md.atom

AndrewKvalheim avatar Oct 21 '25 16:10 AndrewKvalheim