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

Remove all appropriate KS macro calls from our JavaScript documentation #2844

Closed
wbamberg opened this issue Dec 3, 2019 · 8 comments
Closed

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Dec 3, 2019

Depends on https://github.com/mdn/sprints/issues/2520 and https://github.com/mdn/sprints/issues/2523

In https://github.com/mdn/sprints/issues/2520 we triage all the KS macro calls made from our JavaScript documentation. In https://github.com/mdn/sprints/issues/2523 we develop a tool that can selectively remove KumaScript macro calls.

In this story we run the tool over the KumaScript documentation, asking it to remove the macro calls that we triaged as "remove". We then have to review the documentation, to ensure nothing broke.

Acceptance criteria

Our JavaScript documentation no longer contains calls to any macros triaged as "remove".

@Elchi3
Copy link
Member

Elchi3 commented Feb 24, 2020

I've removed all calls for the spec2 macro 🎉

@wbamberg
Copy link
Collaborator Author

wbamberg commented Mar 3, 2020

Based on the latest triage list, we have these macros to remove:

  • Draft
  • non-standard_inline
  • Obsolete_inline
  • experimental_inline
  • deprecated_inline
  • Index

Not sure we can really remove Index yet :(. Should we move it to "Replace/retain"?

@wbamberg
Copy link
Collaborator Author

-> mdn/sprints#2785 (comment) means we can mark Index as removed.

@chrisdavidmills chrisdavidmills transferred this issue from mdn/sprints Feb 8, 2021
@schalkneethling
Copy link

@wbamberg So, the only one that remains is Draft, or is this all taken care of?

@wbamberg
Copy link
Collaborator Author

wbamberg commented Nov 3, 2021

Yeah, we still have several hundred calls to {{Draft}}, although I think we have consensus for removing them.

@schalkneethling
Copy link

Yeah, we still have several hundred calls to {{Draft}}, although I think we have consensus for removing them.

Shall we close this one and spin up a new issue specifically for phasing out Draft?

@wbamberg
Copy link
Collaborator Author

wbamberg commented Nov 4, 2021

Sounds good to me. I started https://github.com/mdn/content/discussions/10273 in case anyone wants to keep it but so far it's looking uncontroversial :).

@schalkneethling
Copy link

#4876

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

3 participants