Skip to content

Commit 2eb7807

Browse files
committed
docs about docs
1 parent 31d0ff6 commit 2eb7807

File tree

2 files changed

+49
-0
lines changed

2 files changed

+49
-0
lines changed

sphinx/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Welcome to Specify Developer documentation!
5252
:caption: Misc:
5353

5454
misc/add_new_instance_to_specify_cloud
55+
misc/documentation
5556
misc/kuit_notes
5657
misc/specify7_ecs_most-in-one
5758
misc/useful_bash_cmds

sphinx/misc/documentation.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Informatics Documentation
2+
############################
3+
4+
There are several options for appropriate documentation, depending on the issue.
5+
6+
Specify code repositories
7+
==========================
8+
9+
Document issues, bugs, tasks, solutions in the appropriate Specify code repository
10+
under https://github.com/specify . These are best for issues
11+
directly tied to modules in the Specify codebase.
12+
13+
specify.github.io
14+
===================
15+
16+
Document reference materials in this internal documentation website. This includes:
17+
project goals, design, implementation strategy, reasoning behind decisions,
18+
maintenance procedures, staff/student expectations, etc.
19+
20+
This site contains testing documentation, such as procedures, database
21+
descriptions, checklists and templates.
22+
23+
This site also acts as a historical record, allowing us access to older considerations
24+
that we do not want to overlook.
25+
26+
The repository is public, though not advertised, so restrict documentation to
27+
non-proprietary information (do not include proposal ideas, passwords, etc.).
28+
29+
30+
specify-development issue repository
31+
======================================
32+
33+
Document technical, but non-code related issues in
34+
https://github.com/specify/specify-development. Include details such as requirements,
35+
related components, database, etc.
36+
37+
Google docs
38+
============
39+
Document meeting notes and works-in-progress needing continual updates by multiple
40+
people here. Documentation that is complete, and to be retained for future access
41+
should be moved to specify.github.io. After moving a document to specify.github.io,
42+
remove it from Google Docs so that it is not updated further there - additional edits
43+
may be made in specify.github.io.
44+
45+
TBD password manager
46+
================================
47+
48+
bitwarden

0 commit comments

Comments
 (0)