Mercurial > p > roundup > code
annotate website/www/docs.txt @ 8185:e84d4585b16d
fix(web): issue2551356. Add etag header for not-modified (304) request.
When a 304 is returned to a conditional request for a static file,
print an ETag for the response.
ETag was always sent with a 200 response.
This also adds initial support for if-none-match conditional requests
for static files.
Changes:
Refactors the if-modified-since code out to a method.
It moves a file stat call from serve_static_file to _serve_file
so that an etag can be generated by both serve_static_file and
serve_file which call _serve_file.
Tests added. This does not test the codepath where serve_file pulls
content from the database rather than from a local file on disk.
Test mocking _serve_file changed to account for 5th argument to serve_file
BREAKING CHANGE:
function signature for client.py-Client::_serve_file() now has 5 not 4
parameters (added etag param). Since this is a "hidden" method I am
not too worried about it.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 10 Dec 2024 16:06:13 -0500 |
| parents | e3b34d02c61a |
| children | 78b13272d41b |
| rev | line source |
|---|---|
|
7048
6f5054751fb6
Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
1 .. meta:: |
|
6f5054751fb6
Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
2 :description: |
|
6f5054751fb6
Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
3 Table of contents for published documentation on the Roundup |
|
6f5054751fb6
Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
4 Issue Tracker. |
|
6f5054751fb6
Update meta description. Also fix test command in code.txt.
John Rouillard <rouilj@ieee.org>
parents:
5941
diff
changeset
|
5 |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
6 Docs |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
7 ==== |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
7358
79fd1bf20543
add welcome preface on reorg to pages
John Rouillard <rouilj@ieee.org>
parents:
7339
diff
changeset
|
9 .. admonition:: Welcome |
|
79fd1bf20543
add welcome preface on reorg to pages
John Rouillard <rouilj@ieee.org>
parents:
7339
diff
changeset
|
10 |
|
7328
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
11 The documentation is slowly being reorganized using the `Diataxis |
|
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
12 framework`_. Help with the reorganization is welcome. If a page you |
|
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
13 used to see is missing, try checking the `Other Docs |
|
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
14 <olderdocs.html>`_ page. |
|
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
15 |
|
7339
5eadba24e148
add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents:
7328
diff
changeset
|
16 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to |
|
5eadba24e148
add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents:
7328
diff
changeset
|
17 documentation. |
|
5eadba24e148
add reference to ReleaseErrata in the wiki
John Rouillard <rouilj@ieee.org>
parents:
7328
diff
changeset
|
18 |
|
7328
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
19 .. _diataxis framework: https://diataxis.fr/ |
|
ce156ad03cb6
add diataxis restructure note. How to find missing docs.
John Rouillard <rouilj@ieee.org>
parents:
7322
diff
changeset
|
20 |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
21 .. toctree:: |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
22 :maxdepth: 2 |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
23 |
|
7432
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
24 Features <docs/features> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
25 Installation <docs/installation> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
26 Upgrading to Newer Versions <docs/upgrading> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
27 Security Issues <docs/security> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
28 FAQ <docs/FAQ> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
29 User's Guide <docs/user_guide> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
30 Customising <docs/customizing> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
31 Rest API <docs/rest> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
32 XML-RPC API <docs/xmlrpc> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
33 Reference <docs/reference> |
|
e3b35dcf0dcb
Shorten/simplify doc TOC by removing redundant Roundup in titles.
John Rouillard <rouilj@ieee.org>
parents:
7358
diff
changeset
|
34 Glossary <docs/glossary> |
|
7322
485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
35 docs/admin_guide |
|
7919
e3b34d02c61a
doc: add html versions of man pages
John Rouillard <rouilj@ieee.org>
parents:
7432
diff
changeset
|
36 docs/man_pages |
|
5941
29d428927362
prep for 2.0.0alpha0 release.
John Rouillard <rouilj@ieee.org>
parents:
4610
diff
changeset
|
37 docs/license |
|
7322
485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
38 docs/acknowledgements |
|
485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
39 olderdocs |
