Skip to content

feat: Generate bcp-index.txt#10631

Merged
kesara merged 10 commits intoietf-tools:mainfrom
kesara:feat/bcp-index
Apr 6, 2026
Merged

feat: Generate bcp-index.txt#10631
kesara merged 10 commits intoietf-tools:mainfrom
kesara:feat/bcp-index

Conversation

@kesara
Copy link
Copy Markdown
Member

@kesara kesara commented Mar 31, 2026

Fixes #10533

Sample: bcp-index.txt (Updated with authors.)

TODO:

  • Update header description. But need more eyes on that.
  • Make sure RFCs are sorted.

@richsalz
Copy link
Copy Markdown
Collaborator

The format description at the beginning of the sample is not correct. No opinion from me on which is better :)

Since this is plain-text, remove the < and > around the URL's to make it easier to cut and paste them.

@kesara
Copy link
Copy Markdown
Member Author

kesara commented Mar 31, 2026

@richsalz, Thanks for the feedback. < and > was added because that's how RFC text files show BCPs in the reference. The new bcp-index.txt follows that format.

@richsalz
Copy link
Copy Markdown
Collaborator

Yes, it follows the RFC text format, but it's still less useful. Will there be HTML versions of the index?

@kesara
Copy link
Copy Markdown
Member Author

kesara commented Mar 31, 2026

Yes, it follows the RFC text format, but it's still less useful. Will there be HTML versions of the index?

No, at the moment only HTML index like view is https://www.rfc-editor.org/bcps which redirects to a search result view.
New rfc-editor website will have the similar functionality with a search results view.

HTML index would be a feature request for future updates on new rfc-editor.org website.

@richsalz
Copy link
Copy Markdown
Collaborator

richsalz commented Apr 1, 2026

Thanks for the answer. I still think the angle brackets is wrong

@kesara kesara marked this pull request as ready for review April 2, 2026 03:16
@ajeanmahoney
Copy link
Copy Markdown
Collaborator

Hi @richsalz, if you would like to push back on angle brackets, please open an issue at https://github.com/rfc-editor/draft-rpc-rfc7322bis/issues, thanks!

@richsalz
Copy link
Copy Markdown
Collaborator

richsalz commented Apr 2, 2026

I don't care about the angle brackets in RFC text format. If I want clickable links, I will go to the HTML version. Since there is no HTML version of this index, users have to cut and paste any URLs in the document. Rendering them with angle brackets make that cut and paste a little harder. That is my point.

@rjsparks
Copy link
Copy Markdown
Member

rjsparks commented Apr 2, 2026

@richsalz part of what we were asked to do with the subseries indices was to match the format that other reference generation, hence Jean's push of your feedback towards the style guide. (And I think it would be good to change that in the style guide).

rjsparks
rjsparks previously approved these changes Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.43%. Comparing base (5775077) to head (2221445).
⚠️ Report is 32 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10631      +/-   ##
==========================================
+ Coverage   88.39%   88.43%   +0.04%     
==========================================
  Files         326      330       +4     
  Lines       43813    44290     +477     
==========================================
+ Hits        38727    39168     +441     
- Misses       5086     5122      +36     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@kesara kesara merged commit a46a2ef into ietf-tools:main Apr 6, 2026
8 of 10 checks passed
@kesara kesara deleted the feat/bcp-index branch April 6, 2026 21:25
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 10, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a celery task to generate bcp-index.txt

4 participants