Commit Graph

43 Commits

Author SHA1 Message Date
daveoconnor
f34458524e Added nix for developer setup (#1379) (#1602)
Tested on brand new machines, made a few minor docs tweaks and adjustments for findings, but generally went well so I'm merging this.
2026-01-05 23:44:10 +00:00
sdarwin
61c651c665 git: small change 2025-11-24 12:59:39 -06:00
daveoconnor
c980879935 Release Report Enhancements (#1750) (#1992) 2025-11-04 14:14:20 -08:00
daveoconnor
5f022aca0a Upgrade django to 5.2, python to 3.13 (#1915) 2025-10-22 13:24:26 -07:00
daveoconnor
e9f93befcd Updated references of boost.io to boost.org (#1870) (#1892) 2025-08-21 11:31:18 -07:00
daveoconnor
2f7cf8514e Word cloud theming, added word listing page (#1623) 2025-02-10 18:19:01 -08:00
Brian Perrett
48c7c87a54 Add the HYPERKITTY_DATABASE_NAME environment variable (#1435) 2024-11-13 09:32:54 -08:00
Brian Perrett
fdeb79b8e3 Sync EmailData from hyperkitty. (#1366)
- This work is a prerequisite for #1290 and #1289
- Create an `EmailData` model which holds email counts per
(CommitAuthor, Version).
- Add management command `sync_mailinglist_stats` to query data from the
hyperkitty database and build `EmailData` objects from it
- EmailData.count is calculated between x.x.0 release_dates
- Add button in EmailData admin to trigger task
- Update the `merge_author` method to update EmailData with the Summed
counts per version and delete EmailData which pointed to the
`CommitAuthor` being merged from.
2024-10-21 09:39:09 -07:00
daveoconnor
142ac66092 onboarding documentation tweaks (#1260) 2024-09-19 16:26:06 -07:00
Sam Darwin
3233fb22c7 docker-compose bootstrap scripts (#1217)
Closes #1216
2024-08-30 07:13:26 -06:00
Sam Darwin
a1d51bb792 Docs: reviewing local docker-compose steps (#1178)
Testing docker-compose. Here are things I noticed.  

- `styles.css` seemed to be missing in the local docker-compose
environment, even though it's present in the docker image. With
docker-compose a volume is mounted. The volume points to your git
repository where styles.css is now git-ignored.
  
Therefore, I am adding steps in the README to build `styles.css`.
@kennethreitz @rbbeeston , is this incorrect? Should the instructions be
different? What method do you use?

- local development: there had been a note to install Python 3.11. Even
though Django containers are running with Python 3.11, it should be
acceptable for the local OS to have the system default of Python 3.10.
They are not directly interacting. Don't modify the system python.

- To view the Users Guide and Contributors Guide, adding variables to
the env.template (and your .env file)

```
STATIC_CONTENT_AWS_ACCESS_KEY_ID=
STATIC_CONTENT_AWS_SECRET_ACCESS_KEY=
STATIC_CONTENT_BUCKET_NAME=
STATIC_CONTENT_REGION=
STATIC_CONTENT_AWS_S3_ENDPOINT_URL=

```

If anyone uses docker-compose and notices the instructions are
incomplete, please comment and/or contribute fixes to the docs.
2024-08-14 12:49:55 -06:00
Kenneth Reitz
ad30efd71b Run yarn build during docker build (#1158)
This will alliviate the merge conflicts we keep getting by checking this
file into source control.


-----------

Now, when using docker-compose, to re-generate the `styles.css` file,
you can do so locally in the following ways:

1. locally run `yarn build`
2. run `docker compose build`
2024-07-22 10:14:44 -04:00
Spencer Strickland
dbcc42c73f Dependency for elasticsearch + Updates to docs 2023-10-25 10:58:58 -05:00
Lacey Williams Henschel
db580bccfb Add staging and preview to readme 2023-10-20 11:36:11 -07:00
Lacey Williams Henschel
1d26e13548 Add docs-level README with table of contents, link to it from main README 2023-09-07 14:14:09 -07:00
Lacey Williams Henschel
6a2a2e4ceb Remove sample data commands 2023-08-03 16:17:06 -07:00
Greg Newman
9b50cd5b35 📝 update readme
Issue: #530
2023-07-18 08:55:04 -04:00
Natalia
a8cd8f507a Ran pre-commit run -a
Completed runs of black and rest of pre-commit checks.
2023-05-30 23:21:53 -03:00
Natalia
ed8808af95 Wrap README at 79 cols 2023-05-30 23:21:53 -03:00
Lacey Williams Henschel
752ea51b5d Add punctuation 2023-05-30 14:25:43 -07:00
sdarwin
0ac2857bf4 Docs: development notes 2023-05-16 14:35:04 -07:00
Frank Wiles
95240039bb Rename 2023-05-11 03:22:43 -05:00
Natalia
1aecc94521 Initial cleanup and adding of new celery task 2023-05-07 20:17:28 -03:00
Lacey Williams Henschel
4881516c63 Present pre-commit data as a table 2023-05-03 19:36:13 -07:00
Lacey Williams Henschel
656ced4e3e Expand on the sample data commands 2023-05-03 19:19:38 -07:00
Lacey Williams Henschel
fd26c6b789 Add info about running individual hooks locally
Thanks @gregnewman!
2023-05-03 19:17:46 -07:00
Lacey Williams Henschel
205e138c4a Clarify pre-commit run 2023-05-03 18:48:52 -07:00
Lacey Williams Henschel
495618d232 Clarify what dropping a volume means 2023-05-03 18:46:17 -07:00
Lacey Williams Henschel
5653fdb626 Clarify fake data instructions 2023-05-03 15:37:38 -07:00
Lacey Williams Henschel
bfec163e1f 📚 More info on pre-commit in README 2023-05-03 15:30:58 -07:00
Natalia
6c7648e6e9 Small improvements to README file based on recent experience 2023-05-02 17:23:37 -03:00
Frank Wiles
9b66dc7d72 Update README
- Remove currently unused and confusing celery compose override file
2023-04-29 16:46:41 -05:00
Greg Newman
0c1b2d99f5 📝 Add pre-commit to readme 2023-04-28 10:21:47 -04:00
Lacey Williams Henschel
dd00808e8e 📚 Add env var docs 2023-04-18 15:51:13 -07:00
Lacey Williams Henschel
f601b67613 Add command to generate test versions 2023-02-01 16:13:41 -08:00
Lacey Williams Henschel
3428012a49 Retrieve markdown from Docker container, render as HTML 2023-01-19 15:37:49 -08:00
Lacey Williams Henschel
1d8edd1730 🐳 Add the Docker volume for website content 2023-01-18 19:40:50 -08:00
Lacey Williams Henschel
f9c2380aee 📚 Document new env variable 2022-12-02 09:48:02 -08:00
Greg Newman
742172f2b4 📝 adding yarn and tailwind to readme 2022-11-17 08:59:02 -05:00
Frank Wiles
5f3476b655 Update README 2022-05-26 08:29:35 -05:00
Greg Newman
f29d3bcc0f Fixing copy in readme 2022-04-01 09:41:27 -04:00
GabbyPrecious
ea792779de change names 2021-11-14 09:35:32 +01:00
GabbyPrecious
0ca0a0b9ac alphakit setup 2021-10-09 09:53:46 +01:00