83 Commits

Author SHA1 Message Date
Athanasius
feed1c27ec
docs/Developers: Fix 'For emphasis' emphasis (markdown) 2022-12-01 13:15:16 +00:00
Athanasius
ecf54c62eb
docs/Developers: Don't split "gamebuild may be empty". 2022-12-01 13:14:03 +00:00
Athanasius
e39fd25e7b
docs/Developers: gamebuild should not be whitespace-trimmed. 2022-12-01 11:36:36 +00:00
Athanasius
cebf3e5ea6
docs/Developers: CAPI-sourced data must denote which galaxy it is for 2022-12-01 11:26:01 +00:00
Athanasius
b00b3737d2
docs/Developers: Don't make it look like advice is about gamebuild
* The ordered-list advice is for `gameversion`, not `gamebuild`.  So move
  the latter mention below that list.
* Also mention `fcmaterials_capi` comes from `market` endpoint.
2022-11-25 15:39:11 +00:00
Athanasius
c54f452bf7
docs/Developers: Compression needs Content-Encoding header
... not `Content-Type`.
2022-10-31 08:52:14 +00:00
Athanasius
1df1032886
docs/Developers: Allow for "" gameversion/build values.
The emphasis here is on strongly encouraging Senders to get the actual, full
and correct, values to Listeners.  But where they can't, be that due to
data source limitations (CAPI), or their code architecture (common EDDN
sending code that has no concept of the data source), they're allowed to
send a less than optimal value.

**BUT**, they still should start sending the fields as outlined.
2022-09-29 14:58:35 +01:00
Athanasius
aa99d3e057
docs/Developers: Use CAPI-<endpoint> for gameversion/build
It's the true source of the data, and less fraught with corner cases than
trying to be sure that the Journal-derived values would be correct.
2022-09-27 16:05:49 +01:00
Athanasius
d57ab05ee3
docs/Developers: Define header component field:values
* Actually define what we expect from the existing fields.
* Document what should go in the new `gameversion` and `gamebuild` fields.
* Update the generic example to include all of these "what version of the game,
  or feature set, did this come from?" fields.
2022-09-27 15:50:17 +01:00
Athanasius
a723fbd83b
docs/Developers: Fix 'i3' vim-induced typo 2022-09-27 14:50:05 +01:00
Athanasius
69cc27fd63
docs/Developers: horizons/odyssey flags now compulsory
* Listeners really do need these, where defined in the schemas, so state
  that they're mandatory.
* REALLY emphasise that where an `Odyssey` flag isn't in `LoadGame` Senders
  MUST NOT send it with a `false` value.

  Although pending addition of header->gameversion will aid Listeners,
  currently this could give the misleading impression that a 3.8 Horizons
  client is a 4.0 Horizons client.
2022-09-27 12:42:14 +01:00
Athanasius
a04d0e8d96
docs/Developers: Update Fileheader/LoadGame for latest clients
This includes the new `4.0 Horizons` client, which changes the semantics
of what the `Odyssey` flag in the `Fileheader` means.  It now indicates if
the client is a 4.0+ one, not if the player is utilising Odyssey DLC.
2022-09-27 12:40:28 +01:00
Athanasius
ff83ede948
Gateway: Remove all form-encoded support
This causes issues, at the least, with compressed messages that 'look' like
they decompressed body is form-encoded.  18385 messages in the last month
rejected due to this.

No actually valid form-encoded messages in that time frame.
2022-06-16 13:27:11 +01:00
Athanasius
9a8ca522e6
docs/Developers: Fix two minor typos 2022-06-13 10:33:13 +01:00
Athanasius
d10b081be4
docs: Outline rules and caveats about data Augmentations
* Many will need a location cross-check.
* Call out this need in the fssbodysignals README.
2022-05-29 14:17:30 +01:00
Athanasius
70a04a4f77
docs/Developers: Call out that Listeners need to pay attention to Augmentations 2022-05-29 12:05:05 +01:00
Athanasius
88cabbf032
docs/Developers: Simplify link to 'Running-this-software.md' 2022-01-30 17:50:49 +00:00
Athanasius
7f6fe9cd76
docs/Adding-A-New-Schema: Reference Contributing.md section
We might just remove this file, but it can stay for now.
2022-01-30 17:43:34 +00:00
Athanasius
36ca116095
docs/Contribyting: Schema READMEs shouldn't repeat what the JSON file states 2022-01-30 17:35:03 +00:00
Athanasius
8de80a868a
docs: More DRY and getting things in the correct places 2022-01-30 15:29:41 +00:00
Athanasius
3b8845d31a
docs: Resolving where "general message contents" lives and its format
* Most of it is once more in schemas/README.
* But keeping the horizons/odyssey flags in docs/Developers.md, as that's
  more about how you handle them in code.
2022-01-30 14:14:59 +00:00
Athanasius
692c28bd75
docs/Developers: Be *very* explicit about the live upload URL 2022-01-30 14:03:16 +00:00
Athanasius
10c43e5304
docs/Developers: Use relative schemas/ link & tweak horizons/odyssey flags reference 2022-01-30 13:07:38 +00:00
Athanasius
ead10a2c1e
docs/Developers: Tweak to why EDMC uses CAPI 2022-01-30 12:59:35 +00:00
Athanasius
de4900ac67
docs/Developers: Import remaining portion of old schemas/README 2022-01-30 12:57:44 +00:00
Athanasius
3e69b7b630
docs: Move most of schemas/README into docs/Developers.md 2022-01-30 12:46:20 +00:00
Athanasius
4ade29866c
docs/Contributing.md: Add some section separators 2022-01-30 12:40:53 +00:00
Athanasius
396a2f0b3a
docs/schemas: Improve "what must be present or removed" 2022-01-30 12:38:32 +00:00
Athanasius
3a2b1d0309
docs/Contributing: Reference schema template files 2022-01-29 18:31:02 +00:00
Athanasius
f384572027
docs/Contributing: Small grammar tweak 2022-01-29 18:27:16 +00:00
Athanasius
180fe9ec94
docs/Contributing: Minor rewording for better grammar 2022-01-28 17:51:32 +00:00
Athanasius
0e791c53b4
docs/Contributing: Keep "must be valid JSON" etc in one place 2022-01-28 17:43:30 +00:00
Athanasius
43ea088f7a
docs/Contributing: 'bried' typo 2022-01-28 17:37:52 +00:00
Athanasius
779fa75b1e
docs/Contributing: Branches, Code Changes, Fix/Enhancement, and more 2022-01-28 17:36:30 +00:00
Athanasius
f1d8a509ca
docs/Contributing: Require test files for new schemas
* Let's have examples in the scripts/testing/gatewat-response directory.
* Actually you usually don't actually need to actually use the word actually.
2022-01-28 17:36:30 +00:00
Athanasius
4239729632
docs/Contributing: Further Schema/README requirements 2022-01-28 17:36:30 +00:00
Athanasius
f8f7b58607
docs/Contributing: Start work on specific Schema/README requirements 2022-01-28 17:36:29 +00:00
Athanasius
e50b57a538
docs/Contributing: Adding 'new schema' guidelines 2022-01-28 17:36:23 +00:00
Athanasius
8ac2ac8ac6 Start a docs/Contributing.md
* Call out the .editorconfig file
2022-01-27 18:23:28 +00:00
Athanasius
8f23bce119 docs/Adding-A-New-Schema: Notes for future reference 2021-09-23 09:41:35 +00:00
Athanasius
e3053dc0b6 systemd: Updates for it to work with current paradigm 2021-07-06 13:29:29 +00:00
Athanasius
474e0e694d docs/Running: Correct virtualenv command to use env name 2021-07-06 12:49:29 +00:00
Athanasius
0e3ef098ab systemd/start-eddn-service: Now replacing scripts/run-from-source.sh
* Removed scripts/run-from-source.sh as it's now redundant.
* Added `--background` optional argument, only for when using
  `--from-source` to start-eddn-service.  The script will leave the
  service in the foreground, no output redirection, without it.

  It tells you the PID of the process when it's backgrounded, as well as
  placing it in the appropriate .pid file.
2021-07-06 11:17:52 +00:00
Athanasius
3116927b12 run-from-source: Moved into new ./scripts/ directory 2021-07-06 10:04:55 +00:00
Athanasius
4bfa81cde8 docs/Running: systemd files now in root rather than contrib/ 2021-07-06 10:04:13 +00:00
Athanasius
547ec2bc22 docs/Running: Section-ise the setup.py install section
* Moves the "you need to edit these files in the monitor" into a section
  related to this, rather than up in #concepts.
2021-07-05 14:36:24 +00:00
Athanasius
50d7af3149 docs/Running: Catch up installation docs with current scripting 2021-07-05 14:16:08 +00:00
Athanasius
0bcb9cc545 docs/Running: Specify network/firewall config, correct some paths and ...
* <hr> between sections
* Document the ports that *must* be open to the internet.
* Apache will require the proxy_http module.
* Move the github clone earlier in instructions, as part of ensuring
  paths exist when they should.
* Note about needing to do hostname and port substitutions in monitor
  files if not using the standard values.
* Link to other sections where appropriate.
2021-07-05 12:52:50 +00:00
Athanasius
fcd316c7d4 docs/Running: Edit and expand LetsEncrypt section 2021-07-02 18:04:34 +00:00
Athanasius
096ccab9fb docs/Running: Outline for using Apache 2021-07-01 17:30:48 +00:00