Skip to content

ug: el2g: add warning about deprecation #758

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 1 commit into from
Oct 9, 2024

Conversation

vanmaegima
Copy link
Member

This is not supported since Oct 1st 2024.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Oct 4, 2024

Copy link
Member

@doanac doanac 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 fine. i wouldn't even mind just deleting this - the next LmP could be months from now and we already don't support it.

@mike-scott
Copy link
Contributor

this is fine. i wouldn't even mind just deleting this - the next LmP could be months from now and we already don't support it.

My concern with deleting immediately is that folks won't know we stopped supporting this.

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

minor little tweaks suggested, but it LGTM.

@@ -3,6 +3,10 @@
Integrating NXP EdgeLock 2GO
============================

.. warning::

The content in this page is not supported in current LmP. This page will be deleted in the next LmP release (v96).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The content in this page is not supported in current LmP. This page will be deleted in the next LmP release (v96).
The content on this page is not supported by the current LmP. This page will be deleted with the next release (v96).

@kprosise
Copy link
Contributor

kprosise commented Oct 8, 2024

@mike-scott @doanac @vanmaegima I think keeping this page with the added warning until v96 is wise. As mike-scott mentioned, it lets folks know it is no longer supported. I worry about someone googling it, and ending up being directed to a outdated version...not that this will prevent that, but perhaps will help reduce that from happening?

Additionally, when we do delete this—or any feature page—we may want to add a redirect...perhaps to a generic, non-indexed page stating it was deprecated, and a link back to the home page? I can do this when it comes time, if we think it would be a good idea.

This is not supported since Oct 1st 2024.

Signed-off-by: Vanessa Maegima <vanessa.maegima@foundries.io>
@vanmaegima
Copy link
Member Author

@kprosise I've addressed your comments

@doanac
Copy link
Member

doanac commented Oct 9, 2024

@kprosise kprosise merged commit 90c27b4 into foundriesio:main Oct 9, 2024
3 checks passed
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.

4 participants