Skip to content
This repository was archived by the owner on Jan 10, 2021. It is now read-only.

Commit 3f4d03b

Browse files
authored
Merge pull request #50 from Slugbotics/wtpisaac/final-doc-pass
Wtpisaac/final doc pass
2 parents a605576 + 3c32f5d commit 3f4d03b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+70
-19839
lines changed

.gitattributes

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Mark doc folder as documentation for Linguist
2+
doc/* linguist-documentation
3+
4+
# And other misc files
5+
static/testing linguist-documentation
6+
7+
# Mark third party dependencies to fix language stats
8+
9+
# JS
10+
static/js/axios.min.js linguist-vendored
11+
static/js/axios.min.map linguist-vendored
12+
static/js/luxon.min.js linguist-vendored
13+
static/js/marked.min.js linguist-vendored
14+
static/js/sugar.min.js linguist-vendored
15+
static/js/utils.js linguist-vendored
16+
static/js/vue.js linguist-vendored
17+
static/js/vue-select.min.js linguist-vendored
18+
static/js/vue.min.js linguist-vendored
19+
20+
# CSS
21+
22+
static/css/bulma.css linguist-vendored
23+
static/css/elements.css linguist-vendored
24+
static/css/vue-select.css linguist-vendored
25+
26+
# We count internal py4web files as part of the project since ostensibly we need to maintain those files

ATTRIBUTION.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,32 @@ The following includes licenses for all third-party depedencies on the frontend
7979

8080
This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
8181

82+
## py4web license (BSD/3 clause)
83+
Copyright (c) 2020, Massimo di Pierro & py4web contributors
84+
All rights reserved.
85+
86+
Redistribution and use in source and binary forms, with or without
87+
modification, are permitted provided that the following conditions are met:
88+
* Redistributions of source code must retain the above copyright
89+
notice, this list of conditions and the following disclaimer.
90+
* Redistributions in binary form must reproduce the above copyright
91+
notice, this list of conditions and the following disclaimer in the
92+
documentation and/or other materials provided with the distribution.
93+
* Neither the name of the copyright holder nor the
94+
names of its contributors may be used to endorse or promote products
95+
derived from this software without specific prior written permission.
96+
97+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
98+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
99+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
100+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
101+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
102+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
103+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
104+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
105+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
106+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
107+
82108
## python-dateutil license (Apache + BSD/3 clause)
83109
Copyright 2017- Paul Ganssle <paul@ganssle.io>
84110
Copyright 2017- dateutil contributors (see AUTHORS file)

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can find thorough documentation on how to use Sluggo in USAGE.md. This is re
1717
graders to read through before giving our application a try.
1818

1919
## Attribution
20-
You can find attribution for some of the open source licenses in ATTRIBUTION.md
20+
You can find attribution for third party libraries in ATTRIBUTION.md
2121

2222
## License
2323
Currently, Sluggo's rights are reserved to the Sluggo team, and of course to the CSE 183 course staff for testing.

USAGE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ This screen will appear for all new accounts added to Sluggo, and enables you to
6262
in Sluggo. If you are an Admin, it will also enable you to create new interests. These interests are stored as
6363
tags in the database.
6464

65+
If you are creating a second account, you must have this account approved by someone with admin status.
66+
Otherwise, you will not be able to edit tickets, along with a variety of actions. This is to prevent
67+
unauthorized members from wreaking havoc on your organization.
68+
6569
## Homepage
6670

6771
![The Default Homepage][blankhome]
@@ -82,7 +86,7 @@ click to be taken to the relevant ticket.
8286
This is a section where you can star tickets of interest to you. You can click on any ticket to view its details.
8387

8488
To star a ticket, go to any ticket's details and click the star button. This will add the starred ticket to your homepage,
85-
and subscribe you to comments and status changes in the Recent Updates section.
89+
and subscribe you to new comments and completion status changes in the Recent Updates section.
8690

8791
### Your Tags
8892
This is a section which contains your interest. Clicking on any tag will bring you to the Tickets screen filtered by

doc/mockup/__init__.py

Lines changed: 0 additions & 8 deletions
This file was deleted.
-198 Bytes
Binary file not shown.
-778 Bytes
Binary file not shown.

doc/mockup/controllers.py

Lines changed: 0 additions & 26 deletions
This file was deleted.

doc/mockup/static/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)