Merge of work to build and deploy teaching guidelines document in multiple formats #70
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
to the main document.
to the document. Performed some clean up on the makefile and added a few comments to it as well. Added some comments and better error messages to the document build script. Made numerous improvements to the document deploy script (e.g., added usage information and added a few comments). Added some comments to the GitHub workflow files.
build and deploy scripts. Fixed a bug in the deploy script introduced by earlier changes.
top-level index.html file in the target repository.
document in the document deploy script.
case that the gh-pages branch does not yet exist.
in several document source files.
authentication during deployment.
for inclusion in the guidelines document.
vulder
pushed a commit
that referenced
this pull request
Feb 6, 2022
…tiple formats (#70) * Added a new attempt at a revised "Guidelines for Teaching C++" document. * Added some information to the README document and made some corrections to the main document. * Document: Revised some of the information in the introductory sections. Added the information for the topic on static_assert. Fixed a few places in the document that were using incorrect terminology. Changed some of the symbols used in the module/topic tables. * Fixed some labelling-related issues in the document. * Made a few minor wording changes to the section on contributing. * Added two WG21 papers to the references section. * Added a logo to the document title and made a few other minor changes to the document. Performed some clean up on the makefile and added a few comments to it as well. Added some comments and better error messages to the document build script. Made numerous improvements to the document deploy script (e.g., added usage information and added a few comments). Added some comments to the GitHub workflow files. * Added some examples to the usage information for the document build and deploy scripts. Fixed a bug in the deploy script introduced by earlier changes. * Changed the document deploy script so that it no longer creates a top-level index.html file in the target repository. * Changed the target of the symlink for the latest version of the document in the document deploy script. * Removed an outdated link from the document. * Made a few improvements to the document deploy script. * Added the creation of a top-level index.html file for the GitHub Pages site. * Added the deployment of built document to the same repository. * Corrected some typos in a workflow file. * Fixed a bug in the deploy script associated with the handling of the case that the gh-pages branch does not yet exist. * Fix a bug in the deploy script. * Fix bug in deploy script. * Testing. * Testing. * Testing. * Testing. * Made changes to file layout. * More reorganizing. * Testing. * Testing. * Revised README. * Replaced HTML markup for tables with the corresponding Markdown markup in several document source files. * Added the missing license text. * Pulled contributor names from the Git repository revision history. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Testing. * Add missing files. * Added a description of the repository organization to the top-level README document. * Made some minor editorial changes to the top-level README. * Fixed a typo in the README. * Fixed wording/spelling in README document. * Added preliminary support for the use of an access token for authentication during deployment. * Fixed a typo in the deploy script. * Made more changes to the deploy script. * Made another change to the deploy script. * Made some editorial changes to the GitHub Actions workflow files. * Commented out some obsolete/unused lines in the release workflow file. * Added mention of some new links in the teaching guidelines document. * Added mention of a new link in the teaching guidelines document. * Removed the copy elision module that is neither complete nor approved for inclusion in the guidelines document. * Removed an obsolete entry in the knowledge areas file. * Moved some files around in order to facilitate easier merging.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@vulder Since you said that you were going to flatten all of my commits when they are merged, I didn't worry too much about my commit log messages. Some of them are rather unhelpful to say the least (e.g., "Testing"). All of this work can really be summarized simply by the following: