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: Add white paper index to the documentation #2591

Merged
merged 21 commits into from
Nov 6, 2023

Conversation

paulgessinger
Copy link
Member

No description provided.

@github-actions github-actions bot added Infrastructure Changes to build tools, continous integration, ... Component - Documentation Affects the documentation labels Oct 27, 2023
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

Merging #2591 (4d8d35b) into main (ed1919b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2591   +/-   ##
=======================================
  Coverage   49.59%   49.59%           
=======================================
  Files         473      473           
  Lines       26824    26824           
  Branches    12355    12355           
=======================================
  Hits        13304    13304           
  Misses       4753     4753           
  Partials     8767     8767           

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

@paulgessinger paulgessinger changed the title add collector for whitepapers docs: Add collector for whitepapers Oct 31, 2023
Copy link
Contributor

@felix-russo felix-russo left a comment

Choose a reason for hiding this comment

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

Should we require a doi for the repos?
I will try and go through the workflow now

docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/tracking.md Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
Copy link
Contributor

@felix-russo felix-russo left a comment

Choose a reason for hiding this comment

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

Really nice! Here are some things we realized during testing

Also:
We could add a folder for images and for macros to he tlatex template

nitpick: I don't know how much of a pain it is to change this, but I think there should be a space between white and paper i.e. white-paper instead of whitepaper

docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
docs/whitepapers/how-to-add.md Outdated Show resolved Hide resolved
whitepaper/update.py Outdated Show resolved Hide resolved
whitepaper/update.py Outdated Show resolved Hide resolved
whitepaper/update.py Outdated Show resolved Hide resolved
@paulgessinger paulgessinger added this to the next milestone Nov 2, 2023
@paulgessinger paulgessinger changed the title docs: Add collector for whitepapers docs: Add white paper index to the documentation Nov 3, 2023
@paulgessinger
Copy link
Member Author

paulgessinger commented Nov 3, 2023

hey @felix-russo

I renamed every thing to use spaces, I also rolled the separate folder whitespaces into the docs folder.
The render step is now executed by the documentation build automatically, so I remove that part of the documentation as well.

I also updated the generation to try to grab a release from the GitHub repo and if it finds one checks for a PDF attached to it. If found, it will link to it. I changed the template CI to run create releases when tags are created.

@paulgessinger paulgessinger marked this pull request as ready for review November 5, 2023 19:55
@paulgessinger paulgessinger modified the milestones: next, v31.0.0 Nov 6, 2023
Copy link
Contributor

@felix-russo felix-russo left a comment

Choose a reason for hiding this comment

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

🚀

@kodiakhq kodiakhq bot merged commit cc2f639 into acts-project:main Nov 6, 2023
53 checks passed
@github-actions github-actions bot removed the automerge label Nov 6, 2023
@acts-project-service acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Nov 6, 2023
@paulgessinger paulgessinger removed the Fails Athena tests This PR causes a failure in the Athena tests label Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Affects the documentation Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants