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

Update hugo/docsy version #6791

Merged
merged 41 commits into from
Nov 27, 2023
Merged

Update hugo/docsy version #6791

merged 41 commits into from
Nov 27, 2023

Conversation

zhiltsov-max
Copy link
Contributor

@zhiltsov-max zhiltsov-max commented Sep 3, 2023

Motivation and context

Newer versions will allow to use several new features, such as tab groups and tags.

  • Updated Docsy to v0.7.1
  • Updated Hugo to v0.110.0
  • Fixed broken layout in the footer
  • Removed unnecessary breadcrumbs on the main page
  • Fixed some links in the footer
  • Updated the build pipeline to build both old and new releases correctly
  • Added VS Code tasks for docs build steps

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have added a description of my changes into the CHANGELOG file
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@codecov
Copy link

codecov bot commented Sep 3, 2023

Codecov Report

Merging #6791 (95abefe) into develop (3bf88c5) will decrease coverage by 0.04%.
The diff coverage is n/a.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6791      +/-   ##
===========================================
- Coverage    81.48%   81.44%   -0.04%     
===========================================
  Files          364      364              
  Lines        39877    39877              
  Branches      3702     3702              
===========================================
- Hits         32494    32479      -15     
- Misses        7383     7398      +15     
Components Coverage Δ
cvat-ui 75.50% <ø> (-0.08%) ⬇️
cvat-server 87.02% <ø> (ø)

@nmanovic
Copy link
Contributor

nmanovic commented Sep 5, 2023

I have some problems with the footer. I used 118 version of hugo. Could you please check?

image

@nmanovic
Copy link
Contributor

nmanovic commented Sep 5, 2023

@kirill-sizov , could you please look at problems with linters?

@zhiltsov-max
Copy link
Contributor Author

zhiltsov-max commented Sep 5, 2023

With 118 it didn't even start when I tested. Please use the 110, which is recommended in the docsy 0.7.1 release and in this PR. I suppose something has been broken in the newer releases.

site/config.toml Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
site/README.md Outdated Show resolved Hide resolved
@SpecLad
Copy link
Contributor

SpecLad commented Sep 25, 2023

Updated Hugo/Docsy versions to the recent ones

There doesn't seem to actually be a Docsy update in this PR.

Copy link
Contributor

@SpecLad SpecLad left a comment

Choose a reason for hiding this comment

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

Seems OK to me, but CI is broken.

@zhiltsov-max
Copy link
Contributor Author

@SpecLad, I fixed the problem, but another one appeared - pages for old versions depend on the old docsy and hugo, and their code is taken from specific tags. Need to think if we can change the building pipeline a little bit to checkout everything needed.

@zhiltsov-max zhiltsov-max changed the title [WIP] Update hugo/docsy version Update hugo/docsy version Oct 17, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 17, 2023

🚫 Workflows has been canceled
📄 See logs here

@zhiltsov-max zhiltsov-max marked this pull request as draft October 17, 2023 14:58
@zhiltsov-max zhiltsov-max marked this pull request as ready for review October 17, 2023 14:59
@zhiltsov-max
Copy link
Contributor Author

pages for old versions depend on the old docsy and hugo, and their code is taken from specific tags. Need to think if we can change the building pipeline a little bit to checkout everything needed.

Fixed. Now several Hugo versions are used during the build.

@SpecLad SpecLad dismissed their stale review October 26, 2023 14:42

It's outdated.

@zhiltsov-max zhiltsov-max merged commit e34fbe3 into develop Nov 27, 2023
33 checks passed
@bsekachev bsekachev deleted the zm/update-docs branch December 5, 2023 12:19
amjadsaadeh pushed a commit to amjadsaadeh/cvat that referenced this pull request Dec 14, 2023
Newer hugo/docsy versions will allow to use several new features, such as tab
groups and tags.

- Updated Docsy to v0.7.1
- Updated Hugo to v0.110.0
- Fixed broken layout in the footer
- Removed unnecessary breadcrumbs on the main page
- Fixed some links in the footer
- Updated the build pipeline to build both old and new releases
correctly
- Added VS Code tasks for docs build steps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants