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

Impove Community documentation #380

Merged
merged 25 commits into from
May 30, 2024
Merged

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Feb 24, 2024

This was a documentation update that focused on enriching the MontePy community.

It did the following:

  1. Adding a contributing guide
  2. Created a changelog
  3. Created CI test that Changelog was updated
  4. Improved organization of documentation.
  5. Improved API documentation table of contents to not just be pages of contents.
  6. Test that the changelog can be updated
  7. Automatically update the changelog version and commit it as part of deploy.

TODO:

  • automatically change version number in changelog

fixes #375, fixes #359, fixes #388.

@MicahGale MicahGale linked an issue Feb 24, 2024 that may be closed by this pull request
4 tasks
@MicahGale MicahGale added documentation Improvements or additions to documentation CI/CD labels Feb 26, 2024
@coveralls
Copy link
Collaborator

coveralls commented Mar 5, 2024

Pull Request Test Coverage Report for Build 9306497564

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.007%) to 98.223%

Totals Coverage Status
Change from base Build 8696920104: -0.007%
Covered Lines: 5750
Relevant Lines: 5854

💛 - Coveralls

@MicahGale MicahGale requested a review from tjlaboss March 9, 2024 07:37
@MicahGale MicahGale marked this pull request as ready for review March 9, 2024 07:37
@MicahGale MicahGale marked this pull request as draft March 9, 2024 19:54
* Created test to see if changelog version can be bumped.

* Gave version bump permissions.

* Gave version system access to full git history.

* Created changelog update version github action

* Create CODE_OF_CONDUCT.md

* Made shell of community documents.

* Made draft contribution guide.

* Started bare changelog.

* Made changelog test.

* Added changelog from previous releases

* Fixed RST syntax.

* Made stub page for scope.

* Made montepy scope and moved design philosophy.

* Made a better landing page, and made the table of contents more nested.

* Fixed section heading error.

* Made clear stance on output files.

* Messed with API TOC to make it actually legible.

* Updated doc test to avoid more undocumented files.

* Fix artifact path.

* Removed deprecated setup python api calls

* Fixed deprecated use of setup python.

* Removed deprecated upload artifacts.

* removed deprecated upload artifacts and test reporter

* removed straggler deprecated upload artifact.

* Actually provided full git history to version bump.

* Only upload one build artifact.

* Updated workflow to have pages after package and to update changelog.

* Update Changelog version to 0.2.7

* Revert "Update Changelog version to 0.2.7"

This reverts commit f7bf982.

* Make sure building pages gets the latest version that was just comitted.

* Update Changelog version to 0.2.8

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@MicahGale MicahGale marked this pull request as ready for review March 9, 2024 21:37
@MicahGale
Copy link
Collaborator Author

For the new deploy system working see: this action and this deployed changelog

@MicahGale
Copy link
Collaborator Author

Should we add #388 to this?

* Created test to see if changelog version can be bumped.

* Gave version bump permissions.

* Gave version system access to full git history.

* Fix artifact path.

* Removed deprecated setup python api calls

* Fixed deprecated use of setup python.

* Removed deprecated upload artifacts.

* removed deprecated upload artifacts and test reporter

* removed straggler deprecated upload artifact.

* Actually provided full git history to version bump.

* Only upload one build artifact.

* Switched to major versions for GHA

* Pin to major only
@MicahGale MicahGale self-assigned this Mar 25, 2024
@MicahGale
Copy link
Collaborator Author

@tjlaboss, you want to procrastinate something?

At this time this seems to be excessive, and does not need to be enumerated. This does not mean this project is the wild west and anything goes, but rather that issues well be address if and when they occur.
@MicahGale MicahGale merged commit f4c3e86 into develop May 30, 2024
14 checks passed
@MicahGale MicahGale deleted the 375-improve-community-documentation branch May 30, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation
Projects
None yet
3 participants