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

Clarify SPEC discussion URLs #369

Open
stefanv opened this issue Jan 9, 2025 · 1 comment
Open

Clarify SPEC discussion URLs #369

stefanv opened this issue Jan 9, 2025 · 1 comment

Comments

@stefanv
Copy link
Member

stefanv commented Jan 9, 2025

Status quo

Currently, the SPEC Purpose & Process says:

  • Each SPEC has a corresponding discussion with the same title, where anyone can comment, ask questions, or vote on existing comments.

Later:

  • Before a proposed SPEC can be accepted, the idea must be discussed on the discussion forum under the SPECS/Ideas topic.

We therefore, currently, have three potential to discuss a SPEC: under SPECS/Ideas, under SPECS/Accepted (Jarrod's been moving SPECS/Ideas to SPECS/Accepted by hand), and under SPECS/Web Comments.
The first (SPECS/Accepted) is pointed to in the header of the SPEC, and the latter is what is embedded below the SPEC on scientific-python.org.

Proposal

We reduce the number of topic categories to two: SPECS/Ideas and SPECS/Web Comments. These serve orthogonal purposes: the first is to figure out whether a SPEC is a good idea, discuss with the proposer how to write the SPEC, etc. This discussion is typically somewhat noisy and technical, and it discusses many things outside of the scope of the SPEC.

Once the SPEC appears on the website (and we should decide whether this means as DRAFT or Published), it is ready for community feedback. These comments are related to the SPEC idea, will be embedded below the SPEC, and will go to SPECS/Web Comments.

Details

  • Remove header link to the originating SPECS/Ideas discussion from SPECs on scientific-python.org
  • Embedding in Discourse is a tad magical, so while embedded comment topics are auto-created, we can only find them after-the-fact. Figure out how to put a link in place in the header, via JS or whatnot, that redirects to SPECS/Web Comments topic.
  • Update the SPEC Purpose and Process to match whatever we decide on here.
  • Update the SPEC template to no longer have a discussion field.
  • Move all SPECS/Accepted posts back to SPECS/Ideas. We could even consider removing those subcategories, so we only have SPECS and SPECS/Web Comments.

Other ideas welcome!

stefanv added a commit to stefanv/scientific-python.org that referenced this issue Jan 30, 2025
stefanv added a commit to stefanv/specs that referenced this issue Jan 30, 2025
This is to align with the recommendations made in
scientific-python#369
stefanv added a commit to stefanv/specs that referenced this issue Jan 30, 2025
In accordance with
scientific-python#369

- Remove originating discussion link from header
- Update specs and process to point to the two relevant discussion categories
stefanv added a commit to stefanv/specs that referenced this issue Jan 30, 2025
In accordance with
scientific-python#369

- Remove originating discussion link from header
- Update specs and process to point to the two relevant discussion categories
@stefanv
Copy link
Member Author

stefanv commented Jan 30, 2025

See the above linked PRs.

jarrodmillman pushed a commit to scientific-python/scientific-python.org that referenced this issue Feb 3, 2025
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

No branches or pull requests

1 participant