From 8bf940951805fba90f694e24bf9ba38d7448d529 Mon Sep 17 00:00:00 2001 From: Benjamin Granados Date: Wed, 10 Jan 2024 11:10:56 +0100 Subject: [PATCH] Improve format and add community platform tools --- INFRASTRUCTURE.md | 43 ++++++++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/INFRASTRUCTURE.md b/INFRASTRUCTURE.md index 265a9b79..c56a1fc5 100644 --- a/INFRASTRUCTURE.md +++ b/INFRASTRUCTURE.md @@ -2,35 +2,31 @@ First, let's address some details of this document. -
- What, why, who... +## What? - ## What? +This document outlines the various systems that JSON Schema the organisation uses and maintains. +This does not include social media profiles. - This document outlines the various systems that JSON Schema the organisation uses and maintains. - This does not include social media profiles. +## Why? - ## Why? +It's part of the required tasks to be completed by the OpenJS Foundation, forming an item of the [onboarding checklist](https://github.com/openjs-foundation/cross-project-council/blob/main/PROJECT_PROGRESSION.md#onboarding-checklist). +It's also probably good practice. - It's part of the required tasks to be completed by the OpenJS Foundation, forming an item of the [onboarding checklist](https://github.com/openjs-foundation/cross-project-council/blob/main/PROJECT_PROGRESSION.md#onboarding-checklist). - It's also probably good practice. +This enables members of the JSON Schema team, and the OpenJS Foundation, to have oversight and management of such infrastructure should it be required. - This enables members of the JSON Schema team, and the OpenJS Foundation, to have oversight and management of such infrastructure should it be required. +## Who? - ## Who? - - This was mainly a list created by Ben Hutton (@relequestual). - Others are free to amend and update this (via Pull Requests) as is required. - -
+This was mainly a list created by Ben Hutton (@relequestual). +Others are free to amend and update this (via Pull Requests) as is required. +## Code and Communication JSON Schema mostly operates on GitHub and Slack. -Our GitHub organisation is located at https://github.com/orgs/json-schema-org. - -Our Slack server is located at https://json-schema.slack.com. +* Our GitHub organisation is located at https://github.com/orgs/json-schema-org. +* Our Slack server is located at https://json-schema.slack.com. (Anyone can join using https://json-schema.org/slack.) +## Domain and hosting The JSON Schema organisation maintains ONE domain name: json-schema.org. The domain name is registered and paid for by the OpenJS Foundation. @@ -38,15 +34,18 @@ The domain name is registered and paid for by the OpenJS Foundation. The domain name defers its name servers to CloudFlare. The DNS mostly points to GitHub. +## Website The website is split into several applications for historical reasons. The main website is run through Cloudflare Pages. The source code is located at https://github.com/json-schema-org/website. + A key set of resources hosted by the site are the JSON Schema meta-schemas, which are used to indicate which schemas are themselves valid for each version of the specification. These resources are potentially heavily used or referred to by consumers of JSON Schema. Links to these resources can be found at https://json-schema.org/specification.html for the latest version of JSON Schema, and at https://json-schema.org/specification-links.html for older versions. The working location for these resources is in the specification repository at https://github.com/json-schema-org/json-schema-spec/, and they are then included into the aforementioned website repository for publishing using `git submodule`. +## Bots The Slack server has a number of bots which feed data into specific channels. The bot which feeds tweets containing JSON Schema from Twitter to the #twitter-mentions is now inactive after the changes in the Twitter API. The bot was created by [Mike Ralphson](https://twitter.com/PermittedSoc). We have no access to it. @@ -61,7 +60,13 @@ The #ghd-community channel bot uses Zapier to process webhooks for our Community The Zapier account is owned and paid for by Postman. If this ever might become a problem, we should move to our own licence. At the time, there was no official app integration. -The Community metrics previously available in Google Analytics are now in Plausible. +## Metrics + +The website metrics previously available in Google Analytics are now in Plausible. + +For the Community metrics we are using Common Room and Orbit. + +## Email We are using mailfence to manage the email accounts associated to json-schema.org.