docs: remove stale WIP markers from developer docs (#8134)#8885
docs: remove stale WIP markers from developer docs (#8134)#8885Flamki wants to merge 3 commits intojenkins-infra:masterfrom
Conversation
|
Hi @gounthar👋 |
|
Hi, |
|
Hi, |
|
Apologies for the ping — I’ll wait for the normal review process. |
|
The original ticket #8134 is supposed to be an auditing task and involves reporting back to us which WIP are no longer required and to remove all the unnecessary ones in the repo and not just a subset of this. Your PR does not seem to have addressed the scope of the ticket completely. |
daniel-beck
left a comment
There was a problem hiding this comment.
I disagree with basically all of these.
Just because there's text on a page doesn't mean it's the text that's expected to be there. E.g., https://www.jenkins.io/doc/developer/handling-requests/actions/ only has content for a specific behavior change several years ago -- and nothing else.
|
Thanks for the feedback. I’ve updated this PR accordingly. I restored Current scope of this PR is now only:
Why these two were kept as removal candidates:
I also completed a full audit of
If you want these two to remain WIP as well, I can revert them too and convert this into an audit-only update. |
|
Hi thanks @Flamki for the follow-up! But your report and thinking are just not detailed and thorough enough. To me the reality for tackling any issue would be either you put in the effort to complete the task to 100% or it would be better not to try in vain at all. This does no one any good to be honest, and it is a waste of maintainer time. |
|
Thanks for the feedback. I completed a full file-by-file audit of all For this PR, I kept scope intentionally minimal and only left two removal candidates:
Everything else remains WIP per the full audit rationale. If you prefer stricter handling, I can revert these two as well and keep this effort audit-only. |
Summary
Audit the developer documentation pages under
/doc/developer/and remove WIP markers from pages that already contain substantial content.This reduces noisy WIP warnings/icons in the Developer Guide while keeping WIP markers on placeholder/stub pages.
Changes
Removed
wip: truefrom:content/doc/developer/architecture/index.adoccontent/doc/developer/architecture/extensions.adoccontent/doc/developer/FIPS-140/index.adoccontent/doc/developer/extensibility/index.adoccontent/doc/developer/handling-requests/actions.adoccontent/doc/developer/security/index.adoccontent/doc/developer/tutorial/index.adoccontent/doc/developer/views/index.adocNotes
WIP markers were intentionally kept on sparse pages that are still mostly placeholders (for example
distributed-builds,model,scheduling, and parts ofinitializationandinternationalization).Deals with #8134