Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
E
edx-platform
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
edx
edx-platform
Commits
adf6df22
Commit
adf6df22
authored
May 16, 2014
by
David Baumgold
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
address review comments from @nedbat
parent
138bd78e
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
10 additions
and
8 deletions
+10
-8
docs/en_us/developers/source/cognitive_load.rst
+9
-7
docs/en_us/developers/source/deploy-new-service.rst
+1
-1
No files found.
docs/en_us/developers/source/cognitive_load.rst
View file @
adf6df22
**************
Co
gnitive Load
**************
**************
*****
Co
de Considerations
**************
*****
This is a checklist of all of the things that we expect a developer to consider
as they are building new or modifying existing functionality.
...
...
@@ -20,13 +20,16 @@ Operational Impact
dashboard to monitor them?
* Am I building a feature that will have impact to the performance of the system?
Keep in mind that Open edX needs to support hundreds of thousands if not
millions of students, so be careful that you code will work well when the
numbers get large.
* Deep Search
* Grade Downloads
* Are reasonable log messages being written out for debugging purposes?
* Will this new feature easily startup in the Vagrant image?
* Do we have documentation for how to startup this feature if it has any
* Will this new feature easily start
up in the Vagrant image?
* Do we have documentation for how to start
up this feature if it has any
new startup requirements?
* Are there any special directories/file system permissions that need to be set?
* Will this have any impact to the CDN related technologies?
...
...
@@ -44,7 +47,7 @@ Documentation/Training/Support
* For Studio much of the documentation is in the product.
* Is this feature big enough that we need to have a session with stake
holders
* Is this feature big enough that we need to have a session with stakeholders
to introduce this feature BEFORE we release it? (PMs, Support, etc...)
* Paid Certificates
...
...
@@ -134,7 +137,6 @@ Collaboration
* Forums/LMS - email
* Does this feature require a special broadcast to external teams as well?
(Stanford, Google, Berkley, etc...)
Open Source
===========
...
...
docs/en_us/developers/source/deploy-new-service.rst
View file @
adf6df22
...
...
@@ -68,7 +68,7 @@ Logging
It's important that your application logging in built out to provide sufficient
feedback for problem determination as well as ensuring that it is operating as
desired. It's also important that your service log using our deployment
standards, i.e., logs v
i
syslog in deployment environments and utilizes the
standards, i.e., logs v
s
syslog in deployment environments and utilizes the
standard log format for syslog. Can the logs be consumed by Splunk? They
should not be if they contain data discussed in the Data Security section below.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment