Skip to content

Commit f860f1b

Browse files
connorjbracyconnorjbracy
committed
Added documentation that instructs users on how to add to/update the site and added a missing publication from the list of prior publictions
1 parent bfd91b4 commit f860f1b

File tree

2 files changed

+155
-4
lines changed

2 files changed

+155
-4
lines changed

Diff for: ‎README.md

+153-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,160 @@
11
diffpy.github.io
22
================
33

4-
Sphinx sources for the diffpy.org web page. This repository contains 3 branches:
4+
Sphinx sources for the [diffpy.org][site] web page.
55

6-
1. `source` sphinx sources for the web page
7-
2. `master` sources compiled to HTML format that are published via GitHub pages
8-
3. `archive` converted subversion repository for the old diffpy.org sources
6+
### Quick Jump:
7+
8+
- [GitHub Structure](#github-structure)
9+
- [Where to Make Changes](#where-to-make-changes)
10+
- [Adding Citations](#adding-citations)
11+
- [Adding Publications that Describe a DiffPy Project (the "Reference" Section)](#reference-section-1)
12+
- [Adding Other Publications (the "Publication Using DiffPy-CMI" Section)](#reference-section-2)
13+
- [Publishing New Version of Existing Project](#new-version)
14+
- [Publishing New Project](#publishing-new-project)
15+
- [Publishing Changes](#publishing-changes)
16+
- [Testing Changes](#testing-changes)
17+
- [Contributors (Submitting Changes)](#submitting-changes)
18+
- [Maintainers (Publishing Changes)](#publishing-changes)
19+
20+
21+
# GitHub Structure
22+
23+
This repository contains 3 branches:
24+
25+
1. [`source`][source] sphinx sources for the web page
26+
2. [`master`][master] sources compiled to HTML format that are published via GitHub pages
27+
3. [`archive`][archive] converted subversion repository for the old diffpy.org sources
928

1029
Please, see the [Wiki](https://github.com/diffpy/diffpy.github.io/wiki) for more
1130
information and tips about this project.
31+
32+
33+
# Where to Make Changes
34+
35+
## Adding Citations
36+
37+
<a name="reference-section-1"></a>
38+
### Adding Publications that Describe a DiffPy Project (the "Reference" Section)
39+
40+
When adding a new publication to the list of [references used within the website](https://www.diffpy.org/publications.html), add the citation text of the publication to the documentation *only once* as a named snippet in [abbreviations.txt](https://github.com/diffpy/diffpy.github.io/blob/source/abbreviations.txt#L286). For example:
41+
```
42+
.. |citeJuhasJac18| replace::
43+
P. Juhás, J. N. Louwen, L. van Eijck, E. T. C. Vogt, S. J. L. Billinge,
44+
`PDFgetN3: atomic pair distribution functions from
45+
neutron powder diffraction data using ad hoc corrections
46+
<https://doi.org/10.1107/S1600576718010002>`__,
47+
*J. Appl. Crystallogr.*, **51**, 1492--1497 (2018)
48+
|downloadJuhasJac18|
49+
```
50+
Here, `|citeJuhasJac18|` is the name that can be used elsewhere in the documentation and the Sphinx documentation generator will replace all instances of this tag with the indented text following the `replace::` directive.
51+
52+
**Important:** After defining the publication's tag as described above, make sure to add the publication to the list of publications maintained in [publications.rst](https://github.com/diffpy/diffpy.github.io/blob/source/publications.rst). Make sure that you add the reference to the proper section and do so in descending reverse chronological order (i.e., the newest citations should appear at the top of their respective sections).
53+
54+
<a name="reference-section-note">*Note:*</a> In this example, the citation is for a publication which describes a product of the DiffPy-CMI project (namely, PDFgetN3). For publications which describe a component of DiffPy-CMI, we provide a link to download the publication directly from the [diffpy.org][site] website. Here, the link is provided via the `|downloadJuhasJac18|` tag which is the identifier for another snippet within [abbreviations.txt](https://github.com/diffpy/diffpy.github.io/blob/source/abbreviations.txt#L294) following the definition of `|citeJuhasJac18|`, seen here as:
55+
```
56+
.. |downloadJuhasJac18| image:: /images/pdficon_small.png
57+
:target: /doc/pdfgetx/Juhas-jac-2018.pdf
58+
```
59+
Furthermore, note that since the initial use of `|downloadJuhasJac18|` occurs within the indented text of the definition of `|citeJuhasJac18|`, the link to `|downloadJuhasJac18|` will appear everywhere `|citeJuhasJac18|` does.
60+
61+
Lastly, make sure that the linked publication has been included within this project's files, placed in an appropriate directory (typically, the parent directory of the project that the paper relates to). In the above example, the publication covers the PDFgetN3 feature of the `pdfgetx` package, thus it is placed within `pdfgetx`'s documentation directory and referenced accordingly with the line
62+
```
63+
:target: /doc/pdfgetx/Juhas-jac-2018.pdf
64+
```
65+
66+
67+
<a name="reference-section-2"></a>
68+
### Adding Other Publications (the "Publication Using DiffPy-CMI" Section)
69+
70+
Adding references to publications that do not describe the release/use of a product within the DiffPy-CMI project (e.g., papers which use some component of DiffPy-CMI), we simply provide the usual citation text (with appropriate DOI link). To add a citation of this type, refer to the information in [Reference Section](#reference-section-1), but disregard everything starting at, and following, the [Note](#reference-section-note).
71+
72+
73+
<a name="new-version"></a>
74+
# Publishing New Version of Existing Project
75+
76+
For releasing an updated version of a project, first follow the release procedure outlined in the [group wiki](https://gitlab.thebillingegroup.com/resources/group-wiki/-/wikis/Finalizing-a-Project's-(Re)-Release) for packaging and deploying your project.
77+
78+
In what follows, [pdfgetx v2.1.1](https://github.com/diffpy/diffpy.pdfgetx/releases/tag/v2.1.1) was chosen to show example commands for the steps outlined.
79+
80+
After following the steps necessary for releasing your project, grab the set of documentation that will be provided with the deliverable upon user's request (typically, this would be something like the files hosted by GitHub on the GitHub releases page). Create a new directory for the updated version's documentation to live in
81+
```
82+
$ mkdir diffpy.github.io/doc/pdfgetx/2.1.1
83+
```
84+
Copy the updated documentation to this directory
85+
```
86+
$ tar --directory=static_root/doc/pdfgetx/2.1.1/ \
87+
--strip-components=4 \
88+
-vxzf ~/Downloads/diffpy.pdfgetx-2.1.1.tar.gz \
89+
diffpy.pdfgetx-2.1.1/doc/manual/_build/PDFgetXNS3_manual.pdf
90+
91+
$ tar --directory=static_root/doc/pdfgetx/2.1.1/ \
92+
--strip-components=5 \
93+
--exclude=objects.inv \
94+
--exclude=.buildinfo \
95+
-vxzf ~/Downloads/diffpy.pdfgetx-2.1.1.tar.gz \
96+
diffpy.pdfgetx-2.1.1/doc/manual/_build/html/
97+
98+
$ cp ~/Downloads/pdfgetxn3-examples.zip static_root/doc/pdfgetx/2.1.1/
99+
```
100+
Make sure to include all relevant files (e.g., `PDFgetXNS3_manual.pdf` and `pdfgetxn3-examples.zip`), exclude any files we don't want to provide to the user (e.g., `objects.inv` and `.buildinfo` from `diffpy.pdfgetx-2.1.1.tar.gz`)
101+
102+
Finally, edit the [landing page of your project](https://github.com/diffpy/diffpy.github.io/blob/source/products/pdfgetx.rst) (in the [`source` branch][source]) to properly document and provide the updated version of your project. Once the preceding steps are complete, see the instructions of the [Publishing Changes](#submitting-changes) section for publishing these changes.
103+
104+
105+
# Publishing New Project
106+
107+
For adding a new project to the website, see one of the existing projects (e.g., [pdfgetx](https://www.diffpy.org/products/pdfgetx.html)) as reference.
108+
109+
In what follows in this section, you will be working within the [`source`][source] branch, unless otherwise specified.
110+
111+
You will need to create a directory for the project to live in within (e.g., [/static_root/doc/pdfgetx](https://github.com/diffpy/diffpy.github.io/tree/source/static_root/doc/pdfgetx)), then write a landing page for the project (e.g., [/products/pdfgetx.rst](https://github.com/diffpy/diffpy.github.io/blob/source/products/pdfgetx.rst)) which will provide any necessary information or files needed for a user to use the project. Once this is complete, see [Publishing New Version of Existing Project](#new-version) for steps on publishing the project.
112+
113+
114+
# Publishing Changes
115+
116+
In order to test and/or publish changes, activate a conda environment that has a working installation of Sphinx (or make sure you have the necessary packages installed at a system level). If unsure how to achieve this, see the [Install Sphinx](https://gitlab.thebillingegroup.com/resources/group-wiki/-/wikis/Finalizing-a-Project's-(Re)-Release#install-sphinx) section of the projecct release wiki.
117+
118+
## Testing Changes
119+
120+
Make sure you have an active installation of Sphinx as per [Publishing Changes](#publishing-changes), run the set of Sphinx validation command(s) to check that the static files that Sphinx will create to be served on the website are written properly:
121+
```
122+
$ make Makefile linkcheck SPHINXOPTS="-W"
123+
```
124+
*NOTE:* the `"-W"` flag forces warnings to be treated as errors. If you believe there is a falsely reported warning that should be ignored that is preventing the test from passing, rerun the above command with the `SPHINXOPTS="-W"` portion omitted.
125+
126+
Additionally, one can visually/user-experience validate that the changes are what is expected by running:
127+
```
128+
$ make Makefile html
129+
```
130+
Then opening `/_build/html/index.html` which will open a local instance of the website with the proposed changes in place.
131+
132+
<a name="submitting-changes"></a>
133+
## Contributors (Submitting Changes)
134+
135+
In order to update the contents of [diffpy.org][site], create a new branch off of [`source`][source] in your local fork of this repo and make whatever changes you need to. Once the desired edits are complete, follow the steps outlined in [Testing Changes](#testing-changes) to verify the site won't break as a result of these changes. Finally, after verifying that the changes won't break things, push your changes to your fork and open a pull-request to submit the changes back into this repo.
136+
137+
<a name="publishing-changes"></a>
138+
## Maintainers (Publishing Changes)
139+
140+
First, follow the steps outlines in [Testing Changes](#testing-changes) to verify that the changes won't mess things up (too bad). Note that these tests, as they currently exist, are not extensive and it's quite possible that something indeed may appear incorrectly on the website (hence the manual review portion). After reviewing the changes, have Sphinx generate the static files to be hosted on the website:
141+
```
142+
$ make Makefile html
143+
```
144+
145+
Prepare the changes to be published:
146+
```
147+
$ make Makefile publish-prepare
148+
```
149+
150+
Finally, publish the changes:
151+
```
152+
$ make Makefile publish-push
153+
```
154+
155+
156+
157+
[site]: <https://www.diffpy.org/> "diffpy.org"
158+
[source]: <https://github.com/diffpy/diffpy.github.io/tree/source> "source"
159+
[master]: <https://github.com/diffpy/diffpy.github.io/tree/master> "master"
160+
[archive]: <https://github.com/diffpy/diffpy.github.io/tree/archive> "archive"

Diff for: ‎publications.rst

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Please cite us if our software has been used in your research.
88

99
* |citeJuhasJac18|
1010

11+
* |citeShiJac18|
12+
1113
* |citeJuhasAca15|
1214

1315
* |citeGranlundAca15|

0 commit comments

Comments
 (0)