Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated file sharing between data-magic and the handbook #41

Open
alexmayberry opened this issue Jun 5, 2023 · 3 comments
Open

Automated file sharing between data-magic and the handbook #41

alexmayberry opened this issue Jun 5, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@alexmayberry
Copy link

We are currently manually adding md files to the climate-tech-handbook repo after they've been batch updated with the API. Also, we have to manually copy md files from the website repo into data-magic in order to perform these batch edits.

Would the solution be to combine these two projects? Or maybe hardcode a standardized file path from data-magic to climate-tech-handbook on the developer's file system?

@alexmayberry alexmayberry added the enhancement New feature or request label Jun 5, 2023
@bigolboyyo
Copy link
Contributor

bigolboyyo commented Jun 5, 2023

My first few thoughts are:

  • as you said create a local solution for developers to auto update
  • deploy the app so the endpoints can be used anywhere (this will take some logic reworking, either: to return the files, write to
    a database, or push the updates to the climate tech handbook main repo)

The hard questions:

  • The infrastructure is there so do we take on integrating @Yinan0409's work for better content? (this will involve creating the methods and endpoints for user interaction) and implementing either a local solution or deployment
  • You can put a fetch/axios request on the frontend that auto hits these endpoints (this was the original concept and idea for the app) but if we want to switch to Docasaurus and used the Decap CMS do we even need this anymore?
  • If we don't need it (or want it), do we consider setting up a serverless function or web worker that runs the embeddings and updates the templates every so often (using essentially the same logic we've already flushed out)?

edit: assigned a bunch of us to get the conversation rolling

My opinion:

We have a lot of logic flushed out and aren't too far in anything. Use workers and server-less functions to run whatever embeddings and updates we need. Switch to Docasaurus to get the power of React/JSX and keep Decap.

  • The power of React will let us be D Y N A M I C
  • Docasaurus is a cooler name 😎
  • Nobody seems to like modeling data and endpoints (server-less is the future for now I'm learning)

@alexmayberry
Copy link
Author

I think we should definitely deploy the app. Serverless would be awesome. We could add authentication and have the api pull/push md files directly to the repo? That would almost be a batch update extension for our CMS.

@allentang9
Copy link

allentang9 commented Jun 5, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Considering
Development

No branches or pull requests

9 participants