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] Migrate docs framework to Docusaurus #282

Merged
merged 46 commits into from
Sep 11, 2021

Conversation

anbraten
Copy link
Member

@anbraten anbraten commented Aug 28, 2021

closes #254
closes #268
closes #165
closes #255

Note: Some parts are marked with TODO as they are based on ongoing changes from other PRs or I simply don't know what to write at that point 😉. I would suggest to leave them for know and create new PRs updating them later.

Todo

  • replace mkdocs with docosaurus (improved menu structure, ...)
  • structure docs into Usage and Server Setup / Administration
  • update favicon
  • Create new pipeline-syntax page with all options and links to more detailed docs if available 🎉 🎉 🎉
  • add ci to publish to woodpecker-ci.github.io
  • deploy docs preview to surge for review
  • update start-page

preview

https://probable-stop.surge.sh

screenshots

Screenshot from 2021-08-29 09-39-47

required actions by maintainer

  • create some bot account for github?
  • create some ssh key and save to woodpecker as GITHUB_PRIVATE_KEY

Docs about deploy workflow

@anbraten anbraten marked this pull request as ready for review August 29, 2021 08:15
@anbraten
Copy link
Member Author

@6543 I updated the docs a "bit" and added some deployment workflow. For that we need some github user with a private ssh key applied to woodpecker to automatically deploy docs. I had the idea that some woodpecker-bot account would be best suited for that.

Could you have a look to the docs cd docs/; yarn install; yarn start.

At the start page we could list some features of woodpecker. What do you think would be suited or should we replace it with something else?

@6543
Copy link
Member

6543 commented Aug 29, 2021

Will take me some time

docs/README.md Show resolved Hide resolved
@6543
Copy link
Member

6543 commented Aug 30, 2021

what's the difference to docs/static/img/logo.svg and docs/static/img/favicon.svg ?

docs/sidebars.js Outdated Show resolved Hide resolved
@anbraten
Copy link
Member Author

what's the difference to docs/static/img/logo.svg and docs/static/img/favicon.svg ?

I don't think there is one. Just replaced the content of the sample files from Docusaurus.

Co-authored-by: 6543 <6543@obermui.de>
.woodpecker/release-docs.yml Outdated Show resolved Hide resolved
@6543 6543 changed the title feat: update docs [Docs] migrate docs framework to Docusaurus Aug 30, 2021
@6543 6543 added the documentation docu & docs label Aug 30, 2021
@6543 6543 added this to the 0.15.0 milestone Aug 30, 2021
@6543 6543 changed the title [Docs] migrate docs framework to Docusaurus [Docs] Migrate docs framework to Docusaurus Sep 11, 2021
@6543 6543 merged commit 9267a46 into woodpecker-ci:master Sep 11, 2021
@anbraten anbraten deleted the update-docs branch September 11, 2021 15:43
@davidak davidak mentioned this pull request Sep 18, 2021
4 tasks
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
3 participants