Skip to content

Add an initial policy for delisting unmaintained projects #9731

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

Merged
merged 42 commits into from
Nov 24, 2022

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Nov 15, 2022

I'm not 100% in love with this content structure,
but I think it's important to get this out.

Closes #9130


📚 Documentation previews 📚

I'm not 100% in love with this content structure,
but I think it's important to get this out.

Closes #9130
Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went through the first part, most of the comments are in the same genre. But looks like we can get this cleared quickly, would be great for the quality of contents served via RTD to have a policy that does exactly what this policy does 👍

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good start.

It's not clear to me if this policy will be applied automatically or only by project owners' requests. I'm assuming the later, but I'd be good to be explicit in the document. My confusion arises because of the "Delisting of an abandoned project" made me think it will be automatic (or without anybody requesting it)

Copy link
Member Author

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is getting close, but the last section still feels muddled to me. This doesn't need to be a legal document, we want to ensure we're communicating what the requirements are, and the actions we take clearly.

Disallow: /


Projects will be delisted if they meet *all* of the following criteria:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're using all here instead of ALL, like above. We should be consistent.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Copy link
Contributor

@agjohnson agjohnson Nov 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note, I changed this to be bold text in another section because using caps for emphasis is an a11y pattern to avoid, generally speaking. Capital letters can affect screen reader usage (some will output this as an acronym, not read it as a word) and all caps can negatively affect readers with dyslexia.

If we're looking for emphasis, we have native options in reST like bold, italic, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alright, changing

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "core" looks good to me. I commented about some details that can be improved.

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty happy to ✅ this PR after going back and forth for days! Great work @benjaoming 💯

@benjaoming
Copy link
Contributor

@ericholscher I guess it can be up to you to review or merge this? 🙏

Copy link
Member Author

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good with my suggested change 👍

@ericholscher
Copy link
Member Author

I do think we also need to address somehow the difference between our abandoned project policy & this one. Otherwise it will be confusing for users.

@benjaoming
Copy link
Contributor

@ericholscher in later Diátaxis documentation refactors, a top-level "Policy" item is added under Reference. Perhaps this level can help to explain differences between policies.

In addition, cross-references might also look good here. Such as adding a tip, "projects may be official but still unmaintained, in this case please see Abandoned Projects Policy".

@benjaoming
Copy link
Contributor

Added ⬆️ as a note for Iteration 2.

@humitos
Copy link
Member

humitos commented Nov 22, 2022

IMO, the difference with the abandoned policy is that in the abandoned one "the requester wants to take ownership of the slug" (e.g. to update the docs or to use it for another project's docs) and in this one that's not the case

@ericholscher
Copy link
Member Author

IMO, the difference with the abandoned policy is that in the abandoned one "the requester wants to take ownership of the slug" (e.g. to update the docs or to use it for another project's docs) and in this one that's not the case

Yea, we just need to make that clear to them :)

@benjaoming
Copy link
Contributor

Added two cross-references.

@benjaoming benjaoming requested a review from humitos November 23, 2022 11:28
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I suggested to update the texts to be more direct.

@ericholscher
Copy link
Member Author

ericholscher commented Nov 23, 2022

I think we're 👍 to merge this. This also does remind me that we aren't currently removing abandoned projects from search results, but we probably should do that too?

Edit: I guess we can just apply both policies to the project! So once we reach out about the abandoned project, we can also mention the delisting. 🤔

@benjaoming
Copy link
Contributor

@ericholscher agreed, policy is good to go 💯

Edit: I guess we can just apply both policies to the project! So once we reach out about the abandoned project, we can also mention the delisting. thinking

This might be hard to remember. I made note of it in my own notes about Abandoned projects. But I can see the entrypoint for a report on a project being either of the policies, so all policy processing could potentially have an additional generic item for the core team member "Check if this project needs action in relation to other of our policies".

@benjaoming benjaoming merged commit c2849d3 into main Nov 24, 2022
@benjaoming benjaoming deleted the outdated-docs-policy branch November 24, 2022 13:20
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 this pull request may close these issues.

Policy for outdated, non-official docs
5 participants