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: store the latest version / latest LTS version in a separate file of APISIX so we can use it to get the latest version in the doc #7538

Open
spacewander opened this issue Jul 26, 2022 · 6 comments
Assignees
Labels
doc Documentation things good first issue Good for newcomers

Comments

@spacewander
Copy link
Member

Current State

We currently hardcore the APISIX version in the blog or doc, which has misled some newcomers when they read an old blog version. This also makes updating the latest APISIX version in the doc harder, because we need to change several places.

Desired State

Let's add a static file containing the version numbers, and provide a simple one-liner command to get the version number in the doc. The one-liner should be very simple so that we can copy & paste it everywhere.

@spacewander spacewander added doc Documentation things good first issue Good for newcomers labels Jul 26, 2022
@juzhiyuan
Copy link
Member

cc @navendu-pottekkat

@pottekkat
Copy link
Contributor

We could maybe make a shell script which installs APISIX. It could have flags that user can set to install LTS version or edge releases. Then the one liner will be to pull the .sh file and execute it. All installation logic will be in the script.

@spacewander
Copy link
Member Author

It is a little complex for a good first issue, but I think it is OK.

@biakecw
Copy link
Contributor

biakecw commented Oct 11, 2022

I found “docs/*/config.json” and “version.lua” contain version_number 。
As a newcomer, I am a little confused about "in the doc"。It is not clear that the context of the "one-liner" execute

@spacewander
Copy link
Member Author

I mean something in the markdown files.

@juzhiyuan juzhiyuan self-assigned this Oct 12, 2022
@juzhiyuan
Copy link
Member

Please leave this issue aside 😊 and I will be available 2 ~ 3 weeks later, and then moving forward with the whole document program with @navendu-pottekkat.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants