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

docs: Introduce deprecation ID for reference in comments and online search #7562

Merged
merged 16 commits into from
Sep 9, 2021

Conversation

mtrezza
Copy link
Member

@mtrezza mtrezza commented Sep 9, 2021

New Pull Request Checklist

Issue Description

Deprecations currently have no unique ID to refer to them in code comments and for developers in online search and forums.
This also makes it difficult to identify code blocks that may be added in anticipation of the removal of a feature without being able to properly reference a deprecation.

Related issue: #n/a

Approach

Add deprecation ID to deprecation table, following syntax:

DEP<REPOSITORY INITIALS><INCREMENTING ID>

Example for "Deprecation - Parse Server - 1":

DEPPS1

This allows to reference server deprecations in SDK without conflict, while allowing to cross-reference deprecations.

Example:

Deprecation no. 1 in Parse JS SDK DEPPJSS1 can be related to Deprecation no. 1 in Parse Server DEPPS1.

TODOs before merging

  • Add entry to changelog
  • Add changes to documentation (guides, repository pages, in-code descriptions)

@parse-github-assistant
Copy link

parse-github-assistant bot commented Sep 9, 2021

Thanks for opening this pull request!

  • 🎉 We are excited about your hands-on contribution!

@mtrezza mtrezza merged commit 429b959 into parse-community:master Sep 9, 2021
@mtrezza mtrezza deleted the add-deprecation-ID branch September 9, 2021 11:09
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 5.0.0-beta.1

@parseplatformorg parseplatformorg added the state:released-beta Released as beta version label Nov 1, 2021
@mtrezza mtrezza mentioned this pull request Mar 12, 2022
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 5.0.0

@parseplatformorg parseplatformorg added the state:released Released as stable version label Mar 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version state:released-beta Released as beta version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants