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

Content services copy integration #38

Closed
2 tasks done
cdcabrera opened this issue Apr 3, 2019 · 3 comments
Closed
2 tasks done

Content services copy integration #38

cdcabrera opened this issue Apr 3, 2019 · 3 comments

Comments

@cdcabrera
Copy link
Member

cdcabrera commented Apr 3, 2019

Feature description

As a developer it would be helpful to be integrated with a documentation or copy based repository so that copy string changes can be made independent of the UI code.

Describe the solution you'd like

  • Option 1: NPM build package reference to a copy repository. Updated strings get checked in to the project manually.
  • Option 2: Full CI integration of the NPM build package. Jenkins would run an additional step where the appropriate copy build script would generate the copy strings. This process would possibly require a baseline or fallback set of strings.

Acceptance Criteria

  • Verify the strings currently (before this update) within the copy repo are being used in ui repo.
  • Verify README or CONTRIBUTION in the UI and copy repos have been updated to explain this process

Additional context

  • Copy strings would be held with JSON resource. The resource could be either loaded through an Ajax request (local files with the ability to expand to an external service in the future), or created as an import module within the app.
  • Changes to UI would involve adding keys/IDs and implementing a i18n package
@cdcabrera
Copy link
Member Author

cdcabrera commented Apr 5, 2019

Baseline string placement ideas

  • Deep scan tooltip, scan dialog/modal
  • Credential, View Credential hover tooltip
  • String identifiers for JSON output
    • place temporary ID strings with the intention they'll be replaced with something CCS can readily identify with

Directory placement

  • use dist/ea_out

@cdcabrera
Copy link
Member Author

As of 20190703...

Quipudocs NPM structure has stabilized, and is ready for NPM consumption.

@jlprevatt-zz
Copy link

As part of this issue, we should consider how we are going to add access to the documentation from the ? menu in the GUI. Such as...

  • Two different options (and decide on labels) for install and user documents

  • A single "Documentation" or "Help" or whatever menu option with the install and user labels as suboptions

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

No branches or pull requests

3 participants