Skip to content

Commit

Permalink
cocalc: more renaming in textfiles
Browse files Browse the repository at this point in the history
  • Loading branch information
haraldschilly committed Apr 3, 2017
1 parent 51383cf commit 185c84f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
4 changes: 3 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Authors

William Stein ([[email protected]](mailto:[email protected])) wrote most of SageMathCloud. See the git history, which as of Oct 30, 2015, has 96% commits by him. This needs to change.
William Stein ([[email protected]](mailto:[email protected])) wrote most of CoCalc (formally called "SageMathCloud"). See the git history, which as of Oct 30, 2015, has 96% commits by him.

For a recent breakdown, run `git shortlog -sn --no-merges`.

Everytime the GPL licensing note refers to the _"Authors of SageMathCloud"_, the following (maybe incomplete) list is meant.

Expand Down
14 changes: 7 additions & 7 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@ Nothing is fully supported yet, but this is the goal.
The directories below have scripts to enable development
in various contexts:

- src/dev/project -- for developing SMC from any project right on SageMathCloud! This is how we do most SMC dev work and is the best supported.
- src/dev/project -- for developing CoCalc from any project right on CoCalc! This is how we do most CoCalc dev work and is the best supported.

- src/dev/single -- for developing SMC on a single computer, e.g., a VM. Must have sudo, and install things system-wide. Each project is a different Linux account.
- src/dev/single -- for developing CoCalc on a single computer, e.g., a VM. Must have sudo, and install things system-wide. Each project is a different Linux account.

- src/dev/docker -- for running SMC in Docker. Not really intended for development use...
- src/dev/docker -- for running CoCalc in Docker. Not really intended for development use...

- src/dev/laptop -- for development on your personal laptop (or desktop) that is not public; zero concern about security. No sudo setup. Works on Linux and OS X. Currently deprecated/not updated.

- src/dev/smc -- related to the actual live SMC deployment, which runs on many nodes, and uses haproxy and nginx. (Will be deprecated)
- src/dev/smc -- related to the actual live CoCalc deployment, which runs on many nodes, and uses haproxy and nginx. (Will be deprecated)

## Issue Triage
For the most part, we mimic [Rust's triage system](https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#issue-triage).

Contributors with sufficient permissions on the SMC repo can help by adding
Contributors with sufficient permissions on the CoCalc repo can help by adding
labels to triage issues:

* Yellow, **A**-prefixed labels state which **area** of SMC the issue relates to.
Expand All @@ -48,7 +48,7 @@ If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
[eeasy]:https://github.com/sagemathinc/cocalc/labels/E-easy


## The Components of SMC
## The Components of CoCalc

### Node.js modules

Expand All @@ -72,7 +72,7 @@ Run whole test suite:
`min` is the minimal reporter and
other reporters are `dot`, `progress`, `nyan` or `json` - [for more see here](http://mochajs.org/)

NOTE: There is not enough testing or coverage of smc-webapp yet.
NOTE: There is only some of smc-webapp, look into its `test` subdirectory.

NOTE: You must already be running the PostgreSQL database, setup so that
`psql` connects to it without having to type a password, before you an
Expand Down
12 changes: 6 additions & 6 deletions src/dev/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# SageMathCloud Docker image
# CoCalc Docker image

This is a self-contained single-image multi-user SageMathCloud server.
This is a self-contained single-image multi-user CoCalc server.

**STATUS:**
- This is _**not blatantly insecure**_: the database has a long random password, user accounts are separate, ssl communication is supported by default, etc.
- That said, **a determined user with an account can very likely access or change files of other users in the same container!** Use this for personal use, behind a firewall, or with an account creation token, so that only other people you trust create accounts. Don't make one of these publicly available with important data in it and no account creation token!
- There are no quotas except idle timeout.
- See the [open docker-related SageMathCloud issues](https://github.com/sagemathinc/cocalc/issues?q=is%3Aopen+is%3Aissue+label%3AA-docker), which may include several issues.
- See the [open docker-related CoCalc issues](https://github.com/sagemathinc/cocalc/issues?q=is%3Aopen+is%3Aissue+label%3AA-docker), which may include several issues.

## Instructions

Expand All @@ -18,7 +18,7 @@ Install Docker on your computer (e.g., `apt-get install docker.io` on Ubuntu).

(If you get an error about the Docker daemon, instead run `sudo docker ...`.)

The above command will first download the image, then start SageMathCloud, storing your data in the directory `~/smc` on your computer. (If you want to store your worksheets and edit history elsewhere, change ~/smc to something else.) Once your local SageMathCloud is running, open your web browser to http://localhost (or https://localhost).
The above command will first download the image, then start CoCalc, storing your data in the directory `~/smc` on your computer. (If you want to store your worksheets and edit history elsewhere, change ~/smc to something else.) Once your local CoCalc is running, open your web browser to http://localhost (or https://localhost).

The docker container is called `smc` and you can refer to the container and use commands like:

Expand All @@ -31,7 +31,7 @@ You can watch the logs:

### Clock skew on OS X

It is **critical** that the Docker container have the correct time, since SMC assumes that the server has the correct time.
It is **critical** that the Docker container have the correct time, since CoCalc assumes that the server has the correct time.
On a laptop running Docker under OS X, the clock will get messed up any time you suspend/resume your laptop. A very easy to install workaround is at https://github.com/arunvelsriram/docker-time-sync-agent/.


Expand Down Expand Up @@ -96,7 +96,7 @@ Once done, you can delete and recreate your smc container. This will not delete

## Build

This section is for SageMathCloud developers.
This section is for CoCalc developers.

Build the image

Expand Down

0 comments on commit 185c84f

Please sign in to comment.