Differences

This shows you the differences between two versions of the page.

--- evergreen-docs:github-workflow [2021/07/22 14:32] – adding some missing steps sandbergja
+++ evergreen-docs:github-workflow [2022/05/12 09:23] – review github's built docs, rather than compiling the docs yourself sandbergja
@@ Line 3: / Line 3: @@
 When someone [[evergreen-docs:how-to-contribute-documentation#intermediate_workflow|submits a change via GitHub]], an Evergreen developer should follow these steps to review it:
-  - Note how many new commits are in the pull request -- you will need this information later.
+===== Reviewing the pull request =====
-  - If you haven't yet, add the main Evergreen repo (on GitHub) as a remote
+  - [[https://github.com/login|Log in to Github]]
+  - Open the pull request in the Github web interface.
+  - Open the Files Changed tab
+  - Make sure the asciidoc changes look good
+  - Open the Checks tab
+  - Expand the "Generate Docs Package" step.  Glance for any unexpected warnings or errors.
+  - Open the Artifacts menu and select built-docs
+  - Unzip the artifact and open it in your browser.
+  - Check to make sure that the expected changes look good in the built docs, and that there are no unexpected changes.
+===== Committing the changes =====
+If everything looks good:
+  - On the commits tab, note how many new commits are in the pull request -- you will need this information later.
+  - In your terminal, if you haven't yet, add the main Evergreen repo (on GitHub) as a remote
     - ''%%git remote add github-evergreen https://github.com/evergreen-library-system/Evergreen.git%%''
   - Update your local master branch to reflect any changes from "origin"
@@ Line 12: / Line 29: @@
   - Cherry pick the relevant commits into your local copy of the master branch.
     - If only one commit: ''git cherry-pick -s [BRANCHNAME]''
-    - If more than one: ''git cherry-pick -s [BRANCHNAME]~[Number of commits]..[BRANCHNAME]'' (for example, if you are bringing in two commits from the survey-docs branch, run ''git cherry-pick survey-docs~2..survey-docs)''
+    - If more than one: ''%%git cherry-pick -s [BRANCHNAME]~[Number of commits]..[BRANCHNAME] --edit%%'' (for example, if you are bringing in two commits from the survey-docs branch, run ''%%git cherry-pick survey-docs~2..survey-docs) --edit%%''
-  - Test build the changed AsciiDoc file + the nav.adoc file(s) that include it
+      - The ''%%--edit%%'' flag will permit you to edit all commit messages as they come in.
-    - ''%%perl ./generate_docs.pl --base-url http://examplesite.org/prod%%''
-    - Check to see if there are any images posted to the Github conversation that have not been committed yet.  Add those to ''Evergreen/docs/modules/<module_name>/assets/images/media/''
-    - Also look for other AsciiDoc warnings or errors
   - Make any corrections (via additional commits, if needed)
   - Use ''git log'' to make sure everything looks good.