altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 4 Packages Projects Releases Wiki Activity

docs: make a short description of starting the dev environment easier to find (#5522)

Browse source 
* doc: make a short description of starting the dev environment easier to find.

* doc: more tl;dr tweaks

* doc: still more tl;dr tweaks

* chore: silly cleanup

* chore: more sillyness

* chore: hoopjumping around semicolons

* chore: _what_ semicolon

* chore: de-red-on-blue a parenthesis

* docs: Update README.md

---------

Co-authored-by: Nicolas Giard <github@ngpixel.com>
This commit is contained in:
Robert Sparks 2023-04-25 12:03:49 -05:00 committed by GitHub
parent 00d302237e
commit ad4f7f2c16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -17,7 +17,7 @@
- [**Production Website**](https://datatracker.ietf.org)
- [Changelog](https://github.com/ietf-tools/datatracker/releases)
- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)
- [Getting Started](#getting-started)
- [Getting Started](#getting-started) - *[ tl;dr ](#the-tldr-to-get-going)*
- [Git Cloning Tips](#git-cloning-tips)
- [Docker Dev Environment](docker/README.md)
- [Database & Assets](#database--assets)
@ -62,6 +62,25 @@ Because of the extensive history of this project, cloning the datatracker projec
git clone --shallow-since=DATE https://github.com/USERNAME/datatracker.git
```
#### The tl;dr to get going
Note that you will have to have cloned the datatracker code locally - please read the above sections.
Datatracker development is performed using Docker containers. You will need to be able to run docker (and docker-compose) on your machine to effectively develop. It is possible to get a purely native install working, but it is _very complicated_ and typically takes a first time datatracker developer a full day of setup, where the docker setup completes in a small number of minutes.
Many developers are using [VS Code](https://code.visualstudio.com/) and taking advantage of VS Code's ability to start a project in a set of containers. If you are using VS Code, simply start VS Code in your clone and inside VS Code choose `Restart in container`.
If VS Code is not available to you, in your clone, type `cd docker; ./run`
Once the containers are started, run the tests to make sure your checkout is a good place to start from (all tests should pass - if any fail, ask for help at tools-develop@). Inside the app container's shell type:
```sh
ietf/manage.py test --settings=settings_postgrestest
```
Note that we recently moved the datatracker onto PostgreSQL - you may still find older documentation that suggests testing with settings_sqlitetest. That will no longer work.
For a more detailed description of getting going, see [docker/README.md](docker/README.md).
#### Overview of the datatracker models
A beginning of a [walkthrough of the datatracker models](https://notes.ietf.org/iab-aid-datatracker-database-overview) was prepared for the IAB AID workshop.