IncludeSponsorsDataEditingCaution < CF

CF Web>TemplateSponsorDataAccounts>IncludeSponsorsDataEditingCaution (2015-01-20, AdrianPepper) (raw view)

---+ Cautionary Notes About Editing the Sponsors Data
<!-- <pre>
    // IncludeSponsorsDataEditingCaution
    // 
    // (Aside: TWiki H1 style is not nice)
    // 
    // This page was primarily designed for inclusion where necessary,
    // but might work well stand-alone, especially with the careful use of
    // the STARTINCLUDE and STOPINCLUDE "variables" which allow a header
    // and footer, although not generalized creation of differences in
    // included and non-included forms.
    // 
    // Note the line after STARTINCLUDE.
    // The CFADRIANGADGETINCLUDE variable renders as a link which 
    // makes it easy for a reader to get to the inclusion to edit it,
    // although the rendered presentation does not seem fully intuitive yet.
    //
</pre>-->
<!-- Bah!  You don't seem to be able to have multiple STOP/STARTINCLUDE -->
%STARTINCLUDE%
---++ Cautionary Notes About Editing the Sponsors Data
%CFADRIANGADGETINCLUDE%
    In general you should avoid making [[SponsorsDataEditingMistakes][easy-to-make mistakes]].

    Nearly all files found in the directory
<pre>
   /software/accounts-master/data/sponsors/
</pre>
    and all directories beneath it, will be processed by the
    [[IncludeSponsorsDataRunSponsorResources][ =sponsor_resources= ]] command.
      Exceptions are files whose name begins with<b> =.= </b>(dot/period)
      and files in sub-directories which sub-directories are named =RCS=.
      If a subdirectory name begins with<b> =.= </b>(dot/period)
    then everything beneath it will be ignored
    (unless referred to explicitly by other files).

    The upshot of that is that you cannot place arbitrary files in these
    directories, or _sponsor_resources_ will stop working correctly.

    When editing the [[SponsorsDataAccounts][sponsors data]] files,
    it can often be convenient to copy and modify previously existing lines
    to create your new additions.
    If you do that, make sure you correctly change all relevant
    =SponsorshipEnds=
    dates,
    or remove them as appropriate.
    Also make sure you delete or change any comments which are
    irrelevant in the new context.  It's better to leave no comments
    than leave confusing comments.

    Consider that the files are intended to help later readers understand
    the sponsorship situation; use a few comment lines (="#"=), and,
    in general, put a blank line before each =%NOP%====%NOP%= line.

    Note that id numbers need to be associated with userids.  This can
    be done directly in the =AssignTo= line as in
<pre>
      AssignTo: sgamgee:02020202
</pre>

    Or it can be done in the =Userids:= section at the top of the file. Only one specific id number can
    be used for a particular userid.  See [[IncludeSponsorsDataIdNumbers]] for details.

    To help make sure we don't slip up and put a real =userid:studentid=
    in one of these pages, we by convention omit =:studentid= in all
    examples.

    Finally, make sure you remember to use the =ci -u= command so you leave the file
    editable by others.

%STOPINCLUDE%

-- Main.AdrianPepper - 20 Jan 2015
---

%INCLUDE{CF.IncludeAdrianReferers}%

Topic revision: r14 - 2015-01-20 - AdrianPepper

Information in this area is meant for use by CSCF staff and is not official documentation, but anybody who is interested is welcome to use it if they find it useful.

Other Webs

My links
- People
- CERAS
- WatForm
- Tetherless lab
- Ubuntu Main.HowTo
- eDocs
- RGG NE notes
- RGG
- CS infrastructure
- Grad images

Edit