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

Add docs for 3.0 #4705

Merged
merged 21 commits into from
Jan 18, 2025
Merged

Add docs for 3.0 #4705

merged 21 commits into from
Jan 18, 2025

Conversation

pat-s
Copy link
Contributor

@pat-s pat-s commented Jan 11, 2025

No description provided.

@woodpecker-bot
Copy link
Contributor

woodpecker-bot commented Jan 11, 2025

Deployment of preview was torn down

@qwerty287
Copy link
Contributor

Afaik you also have to update the docusuarus config. And please delete the oldest docs then (we keep only 3 versions)

@anbraten
Copy link
Member

Would be nice to update docs/src/pages/versions.md here as well.

https://github.com/woodpecker-ci/woodpecker/pull/4297/files might be helpful with some additional hints.

@pat-s
Copy link
Contributor Author

pat-s commented Jan 11, 2025

Would be nice to update docs/src/pages/versions.md here as well.

Going forward there really should be a slicker way than having to edit versions manually in like three or more places for every release.

@pat-s
Copy link
Contributor Author

pat-s commented Jan 11, 2025

Why are routes now missing? Can't spot what's the issue.

@qwerty287 qwerty287 added the documentation docu & docs label Jan 11, 2025
@qwerty287
Copy link
Contributor

@pat-s fixed the route

@xoxys
Copy link
Member

xoxys commented Jan 12, 2025

Afaik you also have to update the docusuarus config. And please delete the oldest docs then (we keep only 3 versions)

@qwerty287 This PR deletes docs for v2.6 now, but I'm a bit confused. If we keep only the last 3 versions, does this mean the last 3 in total? If so we would also have to delete v1 now and only keep v2.7, v2.8 and v3.0 is this correct?

@qwerty287
Copy link
Contributor

I also said that when we dropped the old versions but @anbraten said we should keep 1.0 because there are likely a lot of users still on 1.0.

@xoxys
Copy link
Member

xoxys commented Jan 13, 2025

Mhm I disagree a bit. Keeping at least one older major might make sense but we dont even support v1 anymore or backport fixes to v1. Keeping the docs alive feels wrong somehow.

@xoxys
Copy link
Member

xoxys commented Jan 13, 2025

Ok as nobody else participates here, and we should finish the release, keep it or drop it? I vote for dropping it.

@qwerty287
Copy link
Contributor

We could just do the release without dropping it and discuss that later if we have more activity… but I personally also don't think it should be necessary to keep it.

@xoxys
Copy link
Member

xoxys commented Jan 13, 2025

Ok, then let's keep it for now and proceed.

@anbraten
Copy link
Member

Would drop it some days after we've successfully released 3.0

@qwerty287
Copy link
Contributor

@anbraten looks like your version update wasn't done with the latest version of the CLI docs? At least it looks like there are some (new) flags missing there.

@anbraten
Copy link
Member

I removed the 3.0 folder and created it again after merging main. Is next docs not up to date?

@qwerty287
Copy link
Contributor

The cli docs are not included in got, you have to generate them using make generate-docs

@anbraten
Copy link
Member

You are right. Now it should be fine,

@xoxys
Copy link
Member

xoxys commented Jan 18, 2025

Can you fix the spellcheck?

@xoxys xoxys merged commit bdf753f into main Jan 18, 2025
7 checks passed
@xoxys xoxys deleted the docs/docs-3.0 branch January 18, 2025 19:39
@woodpecker-bot woodpecker-bot mentioned this pull request Jan 18, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation docu & docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants