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 #12

Open
ben-domingue opened this issue Jan 25, 2024 · 2 comments
Open

documentation #12

ben-domingue opened this issue Jan 25, 2024 · 2 comments

Comments

@ben-domingue
Copy link
Collaborator

Documentation: We’ll need to add to the data used here (https://github.com/langcog/irw_site/blob/main/docs.qmd) but I’m quite sure how that will happen.

this currently reads from a static file in the repo (data/IRW Data Dictionary - data index.csv) so a line would need to be added to that, but it would probably be better to convert that to a table on redivis?

it's straightforward to add it as a table, my hesitation is that then any code that lists the tables to iterate over would need to exclude this specific table and that's a bit messy. a potential solution would be to add it as a file instead of as table, so it's a separate thing.

@ben-domingue
Copy link
Collaborator Author

building on the above, i had the same problem already wherein you have to exclude some files (see the 'notdata' bit here: https://redivis.com/projects/qa4k-6qqr2gghq/notebooks/5071). it seems like there should be some way to differentiate but data and metadata but perhaps not....

@KingArthur0205
Copy link
Contributor

KingArthur0205 commented Sep 4, 2024

I came across this issue by accident, and after spending some time with the Redivis API, I think we could approach it in two possible ways:

  1. Create a Separate Project: Since all datasets are currently stored within the irw project, we could create a separate project for this. This would allow us to avoid modifying any existing code that reads in all the datasets.

  2. Change Accessibility Settings: Another option could be adjusting the accessibility and visibility of the documentation so that only specific users have access. This way, users without access wouldn’t see or read this dataset when they iterate through the available datasets. This probably mean that we need to create another user to exclusively access this documentation

I wanted to flag these two potential solutions in case this is still a concern.

These approaches still need to be tested out but seem to be feasible according to the Redivis webpage

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

No branches or pull requests

2 participants