diff --git a/doc/api/api_changes/README.rst b/doc/api/api_changes/README.rst new file mode 100644 index 000000000000..f317cab10d41 --- /dev/null +++ b/doc/api/api_changes/README.rst @@ -0,0 +1,9 @@ +For changes which require an entry in `api_changes.rst` please create +a file in this folder with the name :file:`YYYY-MM-DD-[initials].rst` +(ex :file:`2014-07-31-TAC.rst`) with contents following the form: :: + + Brief description of change + ``````````````````````````` + + Long description of change, justification, and work-arounds to + maintain old behavior (if any). diff --git a/doc/users/whats_new/README.rst b/doc/users/whats_new/README.rst new file mode 100644 index 000000000000..dd8e4a8a5214 --- /dev/null +++ b/doc/users/whats_new/README.rst @@ -0,0 +1,16 @@ +This folder is for placing new portions of `whats_new.rst`. + +When adding an entry please look at the currently existing files to +see if you can extend any of them. If you create a file, name it +something like :file:`cool_new_feature.rst` if you have added a brand new +feature or something like :file:`updated_feature.rst` for extensions of +existing features. Include contents of the form: :: + + Section Title for Feature + ------------------------- + + A bunch of text about how awesome the new feature is and examples of how + to use it. + + A sub-section + `````````````