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: update annotations page #1399

Merged
merged 3 commits into from
Oct 24, 2022

Conversation

pottekkat
Copy link
Contributor

Signed-off-by: Navendu Pottekkat navendu@apache.org

Updates "Annotations" page.

Moves the page out of the "Concepts" section as a separate reference guide.

Signed-off-by: Navendu Pottekkat <navendu@apache.org>
@pottekkat pottekkat added the documentation Improvements or additions to documentation label Oct 21, 2022
Signed-off-by: Navendu Pottekkat <navendu@apache.org>
Signed-off-by: Navendu Pottekkat <navendu@apache.org>
@pottekkat
Copy link
Contributor Author

@tao12345666333 I have moved back the page to under concepts.

Copy link
Member

@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

I think it's good to go, the failed lint is because of another md file.

@juzhiyuan juzhiyuan merged commit 10c3d6e into apache:master Oct 24, 2022
@pottekkat pottekkat deleted the docs/update-annotations/1 branch October 24, 2022 05:56
@pottekkat
Copy link
Contributor Author

@tao12345666333 Now that I think about it, one of the reasons I thought moving the annotations page to a separate root-level page was discoverability for the user. An APISIX Ingress user might want to look up the annotations available and it might not be intuitive to check under the concepts section.

shareinto pushed a commit to shareinto/apisix-ingress-controller that referenced this pull request Oct 27, 2022
Signed-off-by: Navendu Pottekkat <navendu@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants