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

update links in jsonschema to current v1.0.0 docs #2063

Closed
6543 opened this issue Jul 29, 2023 · 6 comments · Fixed by #3369
Closed

update links in jsonschema to current v1.0.0 docs #2063

6543 opened this issue Jul 29, 2023 · 6 comments · Fixed by #3369
Labels
bug Something isn't working documentation docu & docs enhancement improve existing features

Comments

@6543
Copy link
Member

6543 commented Jul 29, 2023

we have a lot of wrong links in the jsonschema linking to old v0.15.0 paths

@6543
Copy link
Member Author

6543 commented Jul 29, 2023

it would also be nice if the 'current' version also has a prefix, this will make links not break that easily

now

  • v0.15 -> https://woodpecker-ci.org/docs/0.15/...
  • v1.0 -> https://woodpecker-ci.org/docs/...
  • next -> https://woodpecker-ci.org/docs/next/...

desired

  • v0.15 -> https://woodpecker-ci.org/docs/0.15/...
  • v1.0 -> https://woodpecker-ci.org/docs/1.0/...
  • next -> https://woodpecker-ci.org/docs/next/...

lastVersion: '1.0',
versions: {
'current': {
label: 'Next',
banner: 'unreleased',
},
'1.0': {
label: '1.0.x',
},
'0.15': {
label: '0.15.x',
banner: 'unmaintained',
},

@6543 6543 added bug Something isn't working documentation docu & docs enhancement improve existing features labels Jul 29, 2023
@6543
Copy link
Member Author

6543 commented Jul 29, 2023

cc @anbraten ☝️ ?

@6543 6543 mentioned this issue Aug 3, 2023
5 tasks
@lonix1
Copy link
Contributor

lonix1 commented Aug 3, 2023

From my dupe issue:

Since #1948 was fixed, the json schema for .woodpecker.yml is out of date.

Consider this code: it ensures the logs show "clone" instead of "git" (as it was before the fix):

clone:
  clone:           # can be any word: "clone", "git" or whatever
    image: woodpeckerci/plugin-git:2.0.3

steps:
    # ...

But the schema only allows "git". If I use "clone" then I get an error in vscode: Property clone is not allowed.

I couldn't submit a PR because I'm unsure how to fix it - I can't just change "git" to "clone" as both are valid, as well as any other word.

@anbraten
Copy link
Member

anbraten commented Aug 25, 2023

it would also be nice if the 'current' version also has a prefix, this will make links not break that easily

Using old links (with a prefix) however will send users to outdated docs (as most users will / should use the newest version anyways) this would introduce more new issues than actually solving.

@gedw99
Copy link

gedw99 commented Aug 25, 2023

Mhh gen json Schema of golang types ?

Saw a package for it last week if there is any interest

@6543
Copy link
Member Author

6543 commented Aug 25, 2023

@gedw99 if you know the link again just comment it here :)

qwerty287 added a commit that referenced this issue Feb 11, 2024
@woodpecker-ci woodpecker-ci locked as resolved and limited conversation to collaborators Feb 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working documentation docu & docs enhancement improve existing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants