scribe-org/scribe-server

Backend service for Scribe app data downloads

.github

Community health files for @scribe-org.

scribe-server's Issues

Add the Scribe-Data JSON files to the /packs path

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

Currently, Scribe-Server is already serving the .sqlite versions under the /packs path. In planning for the ideal state of Scribe-Server, an implementation storing all data in a DB, managing data history, and then allowing for filtered client requests seems to be a good objective. However, that does require a non-trivial amount of development on both the Scribe-Server and Scribe-Data side.

This issue is for trialing an alternative to serving the language packs for the Scribe apps. Could simply serving the .json Scribe-Data files suffice for now to implement data downloads in Scribe apps?

Add linting checks to the development process

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is for adding linting checks to the development process. This may be done by:

• Adding a linting check as a pre-commit git hook
• Adding a linting check within a GitHub Actions CI workflow

Design the pre-rendered data count image

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-Server's Code of Conduct

Description

Currently, data count stats are provided via a Markdown table in Scribe READMEs (example)

Once Scribe-Server is set up to periodically perform the ETL process for Scribe data, updating the data count stats will become troublesome. One idea is to have Scribe-Server pre-render an image with the data count stats and then serve the image to be referenced where needed.

This issue is for the design of the pre-rendered data count image.

Contribution

@andrewtavis would you be able to create a design on Figma for how we would like this to look?

Add Toolforge to the 'Wikimedia Communities' section

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is for adding Toolforge as another community under the Wikimedia Communities section of the Scribe-Server README.md. This likely includes adding the Toolforge logo in the Organization repo as well here

NOTE:

• Toolforge is the platform where Scribe is hosting the Scribe-Server project

Design the API specification for Scribe-Server

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is to track the design and documentation work for the specification/schema of the Scribe-Server API.

Setup user-facing documentation for the API

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is for setting up the user-facing documentation for using the Scribe-Server API. Creation of all the content will be tracked in separate issues, but may include:

• usage examples
• explanations/descriptions of the data

Some ideas for setting this up are via:

• ReadMe
• Redoc

Docker tooling for local development

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-Server's Code of Conduct

Description

This issue is for configuring Docker tooling for local development. Most importantly, this is for running a local instance of MariaDB, which is the DB flavor used in the Toolforge platform where Scribe-Server is hosted.

Goals here are primarily to:

• Configure a MariaDB Dockerfile for local development
• Configure a docker-compose.yaml as well for spinning up the local dev environment

Setting this up is to facilitate development around Scribe-Server's persistence layer

Contribution

No response

Create CI workflow to run tests

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-Server's Code of Conduct

Description

This issue is for creating a GitHub Actions CI workflow to run the tests for the project. For this:

• The tests can be run either via the go CLI itself or via the make test target in the Makefile
• The event trigger for the workflow should be pull_request on the main branch
• Building and testing Go is a reference for GitHub Actions workflows for go

Contribution

No response

Get Scribe-Server on Toolforge

Terms

• I have searched open and closed issues
• I agree to follow Scribe-Server's Code of Conduct

Issue

This issue is to track the operations work needed to get the MVP of Scribe-Server running on Toolforge.

Setup the Scribe-Server project

Terms

• I have searched open and closed feature requests
• I agree to follow Scribe-Server's Code of Conduct

Description

This issue is to track the initial setup for the Scribe-Server project.

Details on the Definition of Done can be more clearly refined in the discussion for the issue. Tentatively, the DoD could be the setup for a minimal server.

Contribution

Will take this on 😎