Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
E
edx-platform-release
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Hsin-Yu Chien
edx-platform-release
Commits
adf6df22
Commit
adf6df22
authored
10 years ago
by
David Baumgold
Browse files
Options
Downloads
Patches
Plain Diff
address review comments from @nedbat
parent
138bd78e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs/en_us/developers/source/cognitive_load.rst
+9
-7
9 additions, 7 deletions
docs/en_us/developers/source/cognitive_load.rst
docs/en_us/developers/source/deploy-new-service.rst
+1
-1
1 addition, 1 deletion
docs/en_us/developers/source/deploy-new-service.rst
with
10 additions
and
8 deletions
docs/en_us/developers/source/cognitive_load.rst
+
9
−
7
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
===========
...
...
This diff is collapsed.
Click to expand it.
docs/en_us/developers/source/deploy-new-service.rst
+
1
−
1
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.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment