diff --git a/docs/app-engine-architecture.md b/docs/app-engine-architecture.md index 453742764..cd6594525 100644 --- a/docs/app-engine-architecture.md +++ b/docs/app-engine-architecture.md @@ -295,9 +295,9 @@ Viewer may help administrators understand what they are seeing. Note that some of these entities are part of App Engine tools that are outside of the domain registry codebase: -* `\_AE\_*` -- These entities are created by App Engine. -* `\_ah\_SESSION` -- These entities track App Engine client sessions. -* `\_GAE\_MR\_*` -- These entities are generated by App Engine while running +* `_AE_*` -- These entities are created by App Engine. +* `_ah_SESSION` -- These entities track App Engine client sessions. +* `_GAE_MR_*` -- These entities are generated by App Engine while running MapReduces. * `BackupStatus` -- There should only be one of these entities, used to maintain the state of the backup process. diff --git a/docs/developing.md b/docs/developing.md index cb4d13070..2e78450bb 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -1,4 +1,4 @@ # Developing -Advice on how to do development on the Domain Registry codebase (including how -to set up an IDE environment and run tests). +Advice on how to do development on the Domain Registry codebase, including how +to set up an IDE environment and run tests. diff --git a/docs/install.md b/docs/install.md index e98632a65..4712b280c 100644 --- a/docs/install.md +++ b/docs/install.md @@ -35,6 +35,7 @@ identically for downloading the zip file. CONTRIBUTING.md google javatests README.md WORKSPACE The most important directories are: + * `docs` -- the documentation (including this install guide) * `java/google/registry` -- all of the source code of the main project * `javatests/google/registry` -- all of the tests for the project @@ -90,8 +91,8 @@ recommended to at least confirm that the default version of the code can be pushed at all first before diving into that, with the expectation that things won't work properly until they are configured. -All of the [EAR](https://en.wikipedia.org/wiki/EAR_(file_format\)) and -[WAR](https://en.wikipedia.org/wiki/WAR_(file_format\)) files for the different +All of the [EAR](https://en.wikipedia.org/wiki/EAR_(file_format)) and +[WAR](https://en.wikipedia.org/wiki/WAR_(file_format)) files for the different environments, which were built in the previous step, are outputted to the `bazel-genfiles` directory as follows: