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

Documentation: Frictionless, Sqlite and Metadata #325

Open
pdelboca opened this issue Apr 15, 2024 · 3 comments · May be fixed by #386
Open

Documentation: Frictionless, Sqlite and Metadata #325

pdelboca opened this issue Apr 15, 2024 · 3 comments · May be fixed by #386
Assignees
Labels
Documentation Issues related to ODE documentation

Comments

@pdelboca
Copy link
Member

Overview

We need to start documenting some technical points of the project so it is easy for newcomers and maintainers. IN today's meeting we detected a key part of how information is created and stored in Open Data Editor.

We need to technically document:

  • Our internal use of Frictionless Framework
  • The use we give to the sqlite database (data and validations)
  • The metadata.json file
  • Some basic diagram of what happens in the application when the user uploads a CSV (Loading, validation, storing, displaying errors, etc)

Let's start with a simple docs folder with a Markdown file. We can think on other solutions later.

@pdelboca pdelboca added the Documentation Issues related to ODE documentation label Apr 15, 2024
@romicolman
Copy link
Collaborator

@roll please, ping me once this is done. The idea is to start translations as soon as you finish working with this. Please, add Pato or Guergana if you want them to review the doc, before we start the translation process.

@roll
Copy link
Collaborator

roll commented May 6, 2024

@romicolman
What kind of translations?

@roll roll linked a pull request May 13, 2024 that will close this issue
@romicolman
Copy link
Collaborator

@roll, sorry my mistake. We discussed this during the planning meeting. Can you please check if based on this documentation you need to add more info to the ODE readme?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to ODE documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants