Uploaded image for project: 'Yetus'
  1. Yetus
  2. YETUS-1012

Major overhaul of precommit documentation

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 0.13.0
    • 0.13.0
    • website and documentation
    • None
    • Hide
      <!-- markdown -->
      The [precommit documentation on the ASF site](http://yetus.apache.org/documentation/in-progress/precommit/) has been revamped! It now features greatly expanded information, more parameters are documented, more commands are documented, and even separate pages per plug-in!
      Show
      <!-- markdown --> The [precommit documentation on the ASF site]( http://yetus.apache.org/documentation/in-progress/precommit/ ) has been revamped! It now features greatly expanded information, more parameters are documented, more commands are documented, and even separate pages per plug-in!
    • Important

    Description

      Before we expand out into GitHub Actions territory, let's re-arrange and overhaul the documentation for precommit to hopefully make it easier to use and discover features.

      Attachments

        Issue Links

          contains

          Improvement - An improvement or enhancement to an existing feature or task. YETUS-792 console report vs. htmlout vs briefout: confusion over bugsystems

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. YETUS-194 Document asflicense exclude file examples

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. YETUS-693 Add warning about requirements for XML test-patch test

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is depended upon by

          New Feature - A new feature of the product, which has yet to be developed. YETUS-992 Create and publish a github action

          • Major - Major loss of function.
          • Resolved
          links to

          Web Link GitHub Pull Request #144

          Activity

            People

              aw Allen Wittenauer
              aw Allen Wittenauer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 2h 10m
                  2h 10m