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

Docusaurus switch #694

Merged
merged 32 commits into from
Jul 17, 2023
Merged

Docusaurus switch #694

merged 32 commits into from
Jul 17, 2023

Conversation

mfocko
Copy link
Member

@mfocko mfocko commented Jul 14, 2023 •
edited
Loading

Fixes #649

TODO:

  • Front page!
  • Documentation
    • Check any Hugo-specific features
    • Convert Hugo details to HTML details
    • Should be done, ready for “rip and tear until it's done”
  • Source-git
    • Check…
    • Hugo links
  • Deployment
  • Research
    • Consider including it; probably follow-up PR, since it requires more changes
  • Blog posts
    • Check…
    • Polish off the “previews”
      • Definitely remove the headings
  • Weekly updates
    • 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
  • Footer
    • Decide what to include: Docusaurus themselves link back the docs, community/contacts, github/mastodon and legal
  • Navbar
    • Probably link back to GitHub, dashboard — basically former external links on the left panel in Hugo
  • Check 1:1 links against Hugo
  • GitHub Action for building (and deploying on merge)
  • Remove stuff from Docusaurus template
  • Consider changing the CSS, e.g. Packit colors instead of the Docusaurus green one
  • Finally! Move out from the nested directory that simplifies rebasing 😰
  • Resolve broken links reported during build
  • Set up search

@mfocko mfocko self-assigned this Jul 14, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/39127888822b48b8961ee331905c3b8f

✔️ pre-commit SUCCESS in 1m 00s
❌ hugo FAILURE in 42s

@mfocko mfocko changed the title Docusaurus switch WIP: Docusaurus switch Jul 14, 2023
@mfocko mfocko added the do-not-merge Work in progress. label Jul 14, 2023
@mfocko mfocko changed the title WIP: Docusaurus switch Draft: Docusaurus switch Jul 14, 2023
@mfocko mfocko changed the title Draft: Docusaurus switch WIP: Docusaurus switch Jul 14, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/e8d1d17862074b0489604df37298311a

✔️ pre-commit SUCCESS in 59s
❌ hugo FAILURE in 41s

@mfocko mfocko mentioned this pull request Jul 14, 2023
Merged
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/d65cd7aca03a4e09bce05ef04aba5f35

✔️ pre-commit SUCCESS in 1m 00s
❌ hugo FAILURE in 42s

@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul

This comment was marked as outdated.

Sign in to view
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/6a82856cf4b04e169c216ad5c189dd45

✔️ pre-commit SUCCESS in 1m 00s

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/84ef1dfa78424aab9b4024c3ccc59bf0

✔️ pre-commit SUCCESS in 58s

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/2026c2699e194c339f428eb8e939e7c3

✔️ pre-commit SUCCESS in 58s

mfocko added 17 commits July 17, 2023 15:07
@mfocko
feat: derive colors from Packit logo
aafe636 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: make front page
eb87e17 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: support aliases
a68d790 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
fix: update references in source-git and admonitions
85d8354 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: show last year of weekly updates on the sidebar
c6a2671 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
fix: use consistent titles and tag weekly updates
2ae84d3 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
ci: add GH Action for building and deploying
9267cc1 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
ci: add workaround before merging deployment PR
d7b6722 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: support mermaid diagrams
f2cd24e 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: enable research
336b27e 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
workaround
4075acb 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
feat: insert templates for blog posts
71e8c1b 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
docs: add makefile targets and document devenv
4813cb2 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
fix: padding on the front-page
30faa29 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
fix: unify contacts between front-page and footer
4eb1d80 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
fix: fix the broken links
f7db779 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko
ci: fail on broken links
5296ee8 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@mfocko mfocko removed the do-not-merge Work in progress. label Jul 17, 2023
@mfocko
feat: allow hiding the sidebar in docs
8b1a35d 
Signed-off-by: Matej Focko <mfocko@redhat.com>
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://softwarefactory-project.io/zuul/t/packit-service/buildset/dce0c8a698da41b592df38d79dff6872

✔️ pre-commit SUCCESS in 1m 03s

lbarcziova
lbarcziova approved these changes Jul 17, 2023
View reviewed changes
Copy link
Member

@lbarcziova lbarcziova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is great, thanks! 🏅 I like the additional features it provides us compared to the previous solution

maybe I would somehow merge Development, Deployment and Research, as these are all kinda development docs to me 🤔 as an outsider seeing e.g. the Research tab, I would be maybe confused...I am also wondering if these could be then somehow visually separated from the other "public-facing" categories

I'm ok with merging as it is and we can iterate more

softwarefactory-project-zuul bot added a commit to packit/deployment that referenced this pull request Jul 17, 2023
@softwarefactory-project-zuul
fix(docs): adjust for docusaurus (#507)
4cab29f 
fix(docs): adjust for docusaurus

Merge with:

packit/packit.dev#694

Reviewed-by: Jiri Popelka
@mfocko mfocko added the mergeit When set, zuul wil gate and merge the PR. label Jul 17, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).
https://softwarefactory-project.io/zuul/t/packit-service/buildset/5c0f2f0632ad4406815119fff510a8c5

✔️ pre-commit SUCCESS in 1m 01s

@softwarefactory-project-zuul
Copy link
Contributor

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.

@mfocko
Copy link
Member Author

mfocko commented Jul 17, 2023

right, GH workflow is included…

@mfocko mfocko merged commit 1f9911e into packit:main Jul 17, 2023
1 check passed
@mfocko mfocko deleted the docusaurus branch July 17, 2023 14:32
mfocko pushed a commit to packit/deployment that referenced this pull request Jan 21, 2024
@softwarefactory-project-zuul
fix(docs): adjust for docusaurus (#507)
8d1d0f3 
fix(docs): adjust for docusaurus

Merge with:

packit/packit.dev#694

Reviewed-by: Jiri Popelka
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@majamassarini majamassarini majamassarini left review comments

@TomasTomecek TomasTomecek TomasTomecek approved these changes

@lbarcziova lbarcziova lbarcziova approved these changes

Assignees

@mfocko mfocko

Labels
mergeit When set, zuul wil gate and merge the PR.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert to Docusaurus and “compile” all documentation
4 participants
@mfocko @majamassarini @TomasTomecek @lbarcziova