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

Define Glossary #1800

Merged
merged 14 commits into from
Jun 3, 2023
Merged

Define Glossary #1800

merged 14 commits into from
Jun 3, 2023

Conversation

6543
Copy link
Member

@6543 6543 commented Jun 1, 2023

based on #745 (comment)

close #1724

@6543 6543 requested a review from anbraten June 1, 2023 20:16
@6543 6543 added the documentation docu & docs label Jun 1, 2023
@6543 6543 added this to the 1.0.0 milestone Jun 1, 2023
@woodpecker-bot
Copy link
Collaborator

woodpecker-bot commented Jun 1, 2023

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-1800.surge.sh

docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
@6543 6543 requested review from anbraten and qwerty287 June 2, 2023 13:54
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
docs/docs/92-development/09-terminology.md Outdated Show resolved Hide resolved
6543 and others added 2 commits June 3, 2023 11:16
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
@6543 6543 enabled auto-merge (squash) June 3, 2023 09:19
@anbraten
Copy link
Member

anbraten commented Jun 3, 2023

What do you think about moving this to the user docs. I guess it would be quite nice if users would read that to for example be able to ask much better questions in the chat, issues.

@6543 6543 disabled auto-merge June 3, 2023 09:22
@6543

This comment was marked as outdated.

@6543
Copy link
Member Author

6543 commented Jun 3, 2023

@anbraten moved, hope it's in a better spot now

@codecov-commenter

This comment was marked as off-topic.

@anbraten
Copy link
Member

anbraten commented Jun 3, 2023

@6543 I had a short look around. And liked how the following pages placed it right after the Getting started area.

So between getting started and pipeline syntax, might be a good place:

image

In addition I checked the search and would suggest we change the terms to headings so they are more important in the search and the user can use easily navigate them and then use the links you have added to navigate to the corresponding pages after getting a short introduction of that term.

Extending to something like those concepts & philosophy pages could be nice in the future as well:

Also really nice is how argo structed their docs in a tranining / like a course way. So you learn step by step more advanced concepts of the tool:

@6543 6543 merged commit 317bd24 into woodpecker-ci:master Jun 3, 2023
@6543 6543 deleted the docu_terminology_1724 branch June 3, 2023 14:40
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.

Add terminology glossary to to the docs
5 participants