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: add v2 ApisixRoute reference #1068

Merged
merged 3 commits into from
Jun 23, 2022

Conversation

stillfox-lee
Copy link
Contributor

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches

What this PR does / why we need it:

issue

I just copy from api_route_v2beta3.md. And add some new rows that already exist in

.

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@tao12345666333 tao12345666333 added the documentation Improvements or additions to documentation label Jun 6, 2022
@tao12345666333 tao12345666333 linked an issue Jun 6, 2022 that may be closed by this pull request
@tao12345666333
Copy link
Member

Can you help to add the v2 documentation for the other resources as well?

@stillfox-lee
Copy link
Contributor Author

Can you help to add the v2 documentation for the other resources as well?

Sure. Sorry for missing the other resources.

@tao12345666333
Copy link
Member

Don't worry, ping me if you need any help

@stillfox-lee
Copy link
Contributor Author

Hi @tao12345666333 , I have a question about our CRD version 2.
In ApisixPluginConfig and ApisixUpstream CRD yaml. There are no v2 but only v2beta3. Maybe we should define v2 CRD then add v2 documentation? Otherwise, doc and our implementation are not unified.

@tao12345666333
Copy link
Member

@stillfox-lee If you pull the latest code from the master branch, you will see the CRD configuration of ApisixPluginConfig v2.

For ApisixUpstream, it can be ignored because we haven't added the v2 implementation yet. until #944 merged

@stillfox-lee
Copy link
Contributor Author

@stillfox-lee If you pull the latest code from the master branch, you will see the CRD configuration of ApisixPluginConfig v2.

For ApisixUpstream, it can be ignored because we haven't added the v2 implementation yet. until #944 merged

Got it, thx.

@codecov-commenter
Copy link

Codecov Report

Merging #1068 (7cceb18) into master (8d76428) will not change coverage.
The diff coverage is n/a.

❗ Current head 7cceb18 differs from pull request most recent head 5446e8b. Consider uploading reports for the commit 5446e8b to get more accurate results

@@           Coverage Diff           @@
##           master    #1068   +/-   ##
=======================================
  Coverage   30.83%   30.83%           
=======================================
  Files          77       77           
  Lines        9140     9140           
=======================================
  Hits         2818     2818           
  Misses       6019     6019           
  Partials      303      303           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update deb0440...5446e8b. Read the comment docs.

@tao12345666333 tao12345666333 self-requested a review June 7, 2022 15:54
@tao12345666333 tao12345666333 self-assigned this Jun 8, 2022
@tao12345666333
Copy link
Member

I can merge the commit records for you later, so that files unrelated to your changes will not appear in the review list

@stillfox-lee
Copy link
Contributor Author

I can merge the commit records for you later, so that files unrelated to your changes will not appear in the review list

Oh, I see. Sorry about that. I'm not familiar with PR workflow. I should just merge upstream to my origin and then commit to the origin branch.

1 similar comment
@stillfox-lee
Copy link
Contributor Author

I can merge the commit records for you later, so that files unrelated to your changes will not appear in the review list

Oh, I see. Sorry about that. I'm not familiar with PR workflow. I should just merge upstream to my origin and then commit to the origin branch.

@tao12345666333
Copy link
Member

Sorry for delay.

I have updated the commit records in this PR.

@tao12345666333
Copy link
Member

@stillfox-lee could you please update the index? Just add all of these filenames

"type": "category",
"label": "References",
"items": [
"references/apisix_route_v2beta3",
"references/apisix_upstream",
"references/apisix_tls",
"references/apisix_cluster_config",
"references/apisix_pluginconfig"

@tao12345666333 tao12345666333 added this to the 1.5.0 milestone Jun 22, 2022
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

The titles of these files also need to be updated, thanks!

docs/en/latest/references/apisix_cluster_config_v2beta3.md Outdated Show resolved Hide resolved
docs/en/latest/references/apisix_route_v2.md Outdated Show resolved Hide resolved
docs/en/latest/references/apisix_tls_v2beta3.md Outdated Show resolved Hide resolved
Copy link
Member

@tao12345666333 tao12345666333 left a comment

Choose a reason for hiding this comment

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

LGTM

@tao12345666333 tao12345666333 merged commit 0f95dbe into apache:master Jun 23, 2022
@stillfox-lee stillfox-lee deleted the doc/apiversion2 branch June 23, 2022 09:52
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.

docs: add v2 apiversion resource reference docs
5 participants