Revamp Internal Horizon Documentation

.gitignore

@@ -2,6 +2,9 @@
 /vendor
 /dist
 /local-archive
+/services/horizon/captive-core
+/services/horizon/horizon
+/services/horizon/stellar-horizon
 .vscode
 .idea
 debug
@@ -12,3 +15,8 @@ debug
 *.key
 *.prof
 *.test
+*.index
+*.xdr
+*.db
+*.conf
+*.lock

DEVELOPING.md

@@ -14,7 +14,7 @@ To checkout, build, and run most tests these tools are required:
 - [Go](https://golang.org/dl) (this repository is officially supported on the last two releases of Go)
 
 To run some tests these tools are also required:
-- PostgreSQL 9.6+ server running locally, or set [environment variables](https://www.postgresql.org/docs/9.6/libpq-envars.html) (e.g. `PGHOST`, etc) for alternative host.
+- PostgreSQL 12+ server running locally, or set [environment variables](https://www.postgresql.org/docs/12/libpq-envars.html) (e.g. `PGHOST`, etc) for alternative host.
 - MySQL 10.1+ server running locally.
 
 ## Get the code

README.md

@@ -80,6 +80,6 @@ Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more detai
 
 ### Developing
 
-See [DEVELOPING.md](DEVELOPING.md) for helpful instructions for getting started developing code in this repository.
+See [DEVELOPING_GUIDE.md](DEVELOPING_GUIDE.md) for helpful instructions for getting started developing code in this repository.
 
 [Stellar Development Foundation]: https://stellar.org

integration.sh

@@ -17,7 +17,7 @@ if [[ "$(docker inspect integration_postgres -f '{{.State.Running}}')" != "true"
     --platform linux/amd64 \
     --env POSTGRES_HOST_AUTH_METHOD=trust \
     -p 5432:5432 \
-    circleci/postgres:9.6.5-alpine
+    circleci/postgres:12-bullseye
 fi
 
 exec go test -timeout 35m github.com/stellar/go/services/horizon/internal/integration/... "$@"

services/horizon/README.md

@@ -3,11 +3,14 @@
 
 Horizon is the client facing API server for the [Stellar ecosystem](https://developers.stellar.org/docs/start/introduction/).  It acts as the interface between [Stellar Core](https://developers.stellar.org/docs/run-core-node/) and applications that want to access the Stellar network. It allows you to submit transactions to the network, check the status of accounts, subscribe to event streams and more.
 
-## Try it out
-See Horizon in action by running your own Stellar node as part of the Stellar [testnet](https://developers.stellar.org/docs/glossary/testnet/). With our Docker quick-start image, you can be running your own fully functional node in around 20 minutes. See the [Quickstart Guide](internal/docs/quickstart.md) to get up and running.
+Check out the following resources to get started:
+- [Horizon Development Guide](internal/docs/GUIDE_FOR_DEVELOPERS.md): Instructions for building and developing Horizon. Covers setup, building, testing, and contributing. Also contains some helpful notes and context for Horizon developers.
+- [Quickstart Guide](https://github.com/stellar/quickstart): An external tool provided from a separate repository. It builds a docker image which can be used for running the stellar stack including Horizon locally for evaluation and testing situations. A great way to observe a reference runtime deployment, to see how everything fits together.
+- [Horizon Testing Guide](internal/docs/TESTING_NOTES.md): Details on how to test Horizon, including unit tests, integration tests, and end-to-end tests.
+- [Horizon SDK and API Guide](internal/docs/SDK_API_GUIDE.md): Documentation on the Horizon SDKs, APIs, resources, and examples. Useful for developers building on top of Horizon.
 
 ## Run a production server
-If you're an administrator planning to run a production instance of Horizon as part of the public Stellar network, check out the detailed [Administration Guide](internal/docs/admin.md). It covers installation, monitoring, error scenarios and more.
+If you're an administrator planning to run a production instance of Horizon as part of the public Stellar network, you should check out the instructions on our public developer docs - [Run an API Server](https://developers.stellar.org/docs/run-api-server/). It covers installation, monitoring, error scenarios and more.
 
 ## Contributing
-As an open source project, development of Horizon is public, and you can help! We welcome new issue reports, documentation and bug fixes, and contributions that further the project roadmap. The [Development Guide](internal/docs/developing.md) will show you how to build Horizon, see what's going on behind the scenes, and set up an effective develop-test-push cycle so that you can get your work incorporated quickly.
+As an open source project, development of Horizon is public, and you can help! We welcome new issue reports, documentation and bug fixes, and contributions that further the project roadmap. The [Development Guide](internal/docs/GUIDE_FOR_DEVELOPERS.md) will show you how to build Horizon, see what's going on behind the scenes, and set up an effective develop-test-push cycle so that you can get your work incorporated quickly.

services/horizon/docker/docker-compose.standalone.yml

@@ -14,7 +14,7 @@ services:
 
   core:
     platform: linux/amd64
-    image: ${CORE_IMAGE:-stellar/stellar-core:18}
+    image: ${CORE_IMAGE:-stellar/stellar-core:19.11.0-1323.7fb6d5e88.focal}
     depends_on:
       - core-postgres
       - core-upgrade

services/horizon/docker/docker-compose.yml

@@ -1,7 +1,8 @@
 version: '3'
 services:
   horizon-postgres:
-    image: postgres:9.6.17-alpine
+    platform: linux/amd64
+    image: circleci/postgres:12-bullseye
     restart: on-failure
     environment:
       - POSTGRES_HOST_AUTH_METHOD=trust