Skip to content

What's Up GitHub improvements -- suggestions for improvement #11

@meker12

Description

@meker12
  • Add a column to the table with name of guide/publication updated (possibly with link to landing page.)
  • Update script so that it doesn't write records for Technical changes that don't have a whatsnew description (MISSING) (Issue Do not report about MISSING news in the output file  #7)

Goal: Automate everything up to the part where a human needs to review the update and make sure any issues are corrected. (edited)

Automate the process to create the draft What's New for review/work:

  1. Check out and update master
  2. Create a new "whatsnew-update" branch.
  3. Run the whatsnew since command from the DevDocs src directory -- provide a way to interactively specify the date (maybe have the job auto-run on a weekly basis,)
  4. Commit the tmp/whatsnew.yml file.
  5. Submit the PR to master/small changes for further work/review.
  6. Create a JIRA task to review the output and update as needed.

In the results file:
-- Parse out the publication name from the path to the affected source file
-- Have lookup table that matches parsed folder name to correct book title. Add the book title with link to landing page for that topic.
-- If we can get the tmp/whatsnew file to be cleanly generated from the PR whatsnew entries without requiring further editing, automatically prepend the results of the whatsup script to the _data/whats-new.yml file.
-- Generate the html file output.
-- Check for broken or redirected links in What's new content.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions