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.

Sign up for GitHub

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

Jump to bottom

Convert to Docusaurus and “compile” all documentation #649

Closed
3 tasks
mfocko opened this issue May 11, 2023 · 0 comments · Fixed by #694
Closed
3 tasks

Convert to Docusaurus and “compile” all documentation #649

mfocko opened this issue May 11, 2023 · 0 comments · Fixed by #694
Labels
area/general Related to whole service, not a specific part/integration. complexity/single-task Regular task, should be done within days. gain/low This doesn't bring that much value to users. impact/low This issue impacts only a few users. kind/documentation Documentation needs updates. kind/internal Doesn't affect users directly, may be e.g. infrastructure, DB related. workaround-exists There is an existing workaround that can be used in the meantime of implementing the issue.

Comments

@mfocko
Copy link
Member

mfocko commented May 11, 2023

Currently we have:

  • this repository containing weekly posts, docs, blog posts
  • research repository for spikes and arch/design decisions
  • deployment docs
  • contributing guidelines
    • additionally repo-specific contribution guidelines

This setup is fragmented and not very intuitive, since the extensive documentation is spread across multiple repositories (or even directories within one repository).

TODO:

  • Switch to Docusaurus -- this allows us to separate the docs into multiple sections; also brings more functionality compared to Hugo (regarding the formatting, etc.)
  • »Slowly« migrate fragments into one documentation that can be used both internally by the team and also by the users
    • There are issues with links and also handling of the images, preview below is MVP

Preview: https://me.mfocko.xyz/packit
(source for the preview; internal-only)
@mfocko mfocko added kind/documentation Documentation needs updates. area/general Related to whole service, not a specific part/integration. complexity/single-task Regular task, should be done within days. gain/low This doesn't bring that much value to users. impact/low This issue impacts only a few users. kind/internal Doesn't affect users directly, may be e.g. infrastructure, DB related. workaround-exists There is an existing workaround that can be used in the meantime of implementing the issue. labels May 11, 2023
@mfocko mfocko mentioned this issue Jul 17, 2023
Merged
36 tasks
mfocko added a commit that referenced this issue Jul 17, 2023
@mfocko
Docusaurus switch (#694)
1f9911e 
Fixes #649 

* Live preview: https://me.mfocko.xyz/packit

TODO:

- [x] Front page!
- [x] Documentation
  - [x] Check any Hugo-specific features
  - [x] Convert Hugo details to HTML details
  - [x] Should be done, ready for “rip and tear until it's done”
- [x] Source-git
  - [x] Check…
  - [x] Hugo links
- [x] Deployment
  - [x] Merge the changes back into the deployment repo
  - [ ] packit/deployment#507
- [x] Research
- [x] Consider including it; probably follow-up PR, since it requires
more changes
- [x] Blog posts
  - [x] Check…
  - [x] Polish off the “previews”
    - [x] Definitely remove the headings
- [x] Weekly updates
  - [x] Check…
  - [ ] Consider switching to post per week
- [ ] Make sure the RSS for weekly updates is updated in the linked
Fedora digest or something! ask @xsuchy
- [ ] Shortcodes redo
  - [ ] Architecture
  - [ ] Usage charts
  - [ ] Workflow
- [x] Footer
- [ ] Decide what to include: Docusaurus themselves link back the docs,
community/contacts, github/mastodon and legal
- [x] Navbar
- [x] Probably link back to GitHub, dashboard — basically former
external links on the left panel in Hugo
- [ ] Check 1:1 links against Hugo
- [x] GitHub Action for building (and deploying on merge)
- [x] Remove stuff from Docusaurus template
- [x] Consider changing the CSS, e.g. Packit colors instead of the
Docusaurus green one
- [x] Finally! Move out from the nested directory that simplifies
rebasing 😰
- [x] Resolve broken links reported during build
- [ ] Set up
[search](https://docusaurus.io/docs/search#using-algolia-docsearch)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/general Related to whole service, not a specific part/integration. complexity/single-task Regular task, should be done within days. gain/low This doesn't bring that much value to users. impact/low This issue impacts only a few users. kind/documentation Documentation needs updates. kind/internal Doesn't affect users directly, may be e.g. infrastructure, DB related. workaround-exists There is an existing workaround that can be used in the meantime of implementing the issue.
Projects
Packit Kanban Board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docusaurus switch mfocko/packit.dev
1 participant
@mfocko