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

Org/lang/resource/branch RCL #2

Open
birchamp opened this issue Jun 13, 2022 · 2 comments
Open

Org/lang/resource/branch RCL #2

birchamp opened this issue Jun 13, 2022 · 2 comments
Assignees

Comments

@birchamp
Copy link
Contributor

Allow a user to navigate to a specific resource and branch (optionally)

@birchamp
Copy link
Contributor Author

@jincypjose has done work on the UI and plans to use the DCS React hooks to get the orgs/ langs / resource.

@mandolyte
Copy link

So here is current thinking on this...
An RCL which consists of two parts:

  • a hook that manages state for user navigation
  • a simple UI as a reference implementation for the hook

The Reference UI

The UI will consists of three dropdowns:

  • The first dropdown will contain a list of all orgs in DCS. This will be pre-populated at the beginning.
  • The second dropdown will contain a list of all repos in the selected org. This dropdown will be disabled until an org is selected
  • The third dropdown will consist of all branches in the selected repo. It will default to "master" (or whatever the default branch is). This dropdown will be disabled until a repo is selected.

The fourth dropdown has a couple of alternatives

Alternative A: Select by File
The fourth dropdown will be a file picker of all the files in the selected branch. For now, propose that only files in the root be considered. This works for all tsv and usfm resources, but not for TA or TW. A tree navigation feature would be needed to support going beyond the root folder.

Alternative B: Select by Book
If selected by book, some built-in intelligence is need to compute the filename based on the type of resource the repo is supposed to contain.

  • For TSV and USFM resource types, the derivation of the filename is straightforward
  • For TA, the TN is needed to identify which TA articles to include for the book
  • For TW, the TWL is needed to identify which TW articles to include for the book.

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

4 participants