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

[DOC] Requesting deprecation warning for legacy templates within Index templates documentation #5193

Open
1 of 4 tasks
r1walz opened this issue Oct 12, 2023 · 5 comments
Open
1 of 4 tasks
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers

Comments

@r1walz
Copy link

r1walz commented Oct 12, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

Index Templates (templatesV2; ep: /_index_template) documentation should mention deprecation warning about the previous gen templates v1 (ep: /_template) API.

While _cat/templates list down both legacy as well as Index templates, there are separate APIs for interacting with both. Having a deprecation warning can help users to identify the differences between the information provided by _cat/templates and /_index_template/*.

Long time systems may still be using legacy templates, new users onboarding to them may find it difficult to dig through the existence of legacy templates, creating confusion. (I'm unable to find any documentation on our docs page for legacy templates).

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

There are no easily available resources to look for this discrepancy.

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers backport 2.10 PR: Backport label for 2.10 and removed untriaged labels Oct 16, 2023
@samipak458
Copy link
Contributor

@Naarcha-AWS I would like to contribute on this.

@Naarcha-AWS Naarcha-AWS removed the backport 2.10 PR: Backport label for 2.10 label Nov 4, 2023
@hdhalter
Copy link
Contributor

Hi @r1walz - Are you still planning to work on this? Thanks.

@r1walz
Copy link
Author

r1walz commented Nov 29, 2023

Hi, @hdhalter. I believe @samipak458 picked it up earlier. If it is not scheduled under his plan then feel free to pick it up yourself. Thanks!

@hdhalter
Copy link
Contributor

hdhalter commented Dec 1, 2023

Hi, @hdhalter. I believe @samipak458 picked it up earlier. If it is not scheduled under his plan then feel free to pick it up yourself. Thanks!

I am only triaging, but yes, I tagged the wrong person! Let's see if @samipak458 picks it up.

@drewmiranda-gl
Copy link
Contributor

Greetings! I found this issue while searching for any documentation for when legacy templates will be fully removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants