Skip to content
This repository has been archived by the owner on Sep 4, 2023. It is now read-only.

Incorporate proper readme and architecture docs #39

Closed
andrenatal opened this issue Jan 21, 2022 · 6 comments
Closed

Incorporate proper readme and architecture docs #39

andrenatal opened this issue Jan 21, 2022 · 6 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@andrenatal
Copy link
Contributor

No description provided.

@andrenatal andrenatal self-assigned this Jan 21, 2022
@andrenatal andrenatal added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 26, 2022
@kpu
Copy link
Contributor

kpu commented Feb 9, 2022

In light of #55 (thanks), I want the UI people to be trying the outbound translation feature. Is there a document aimed at a technical windows user who doesn't have npm on how to use the very latest extension? Steps like get nightly, edit stuff in about:config, install XPI. It seems the XPI is built on tags https://github.com/mozilla/firefox-translations/actions/workflows/publish_artifact.yml

@andrenatal
Copy link
Contributor Author

andrenatal commented Feb 9, 2022

Every commit builds and artifact, so one could:

1 - Download the artifact from here https://github.com/mozilla/firefox-translations/actions/runs/1818968414. It will be downloaded as a zip
2 - In Nightly, type about:addons click on the gear, then install from a file and load the saved zip file.
3 - On about:config change extensions.translations.disabled to true; extensions.experiments.enabled to true; javascript.options.wasm_simd_wormhole to true

This should be enough.

@kpu
Copy link
Contributor

kpu commented Feb 9, 2022

Add xpinstall.signatures.required to false since that job isn't signing then it worked. Can we add a README section?

@andrenatal
Copy link
Contributor Author

Feel free.

@andrenatal
Copy link
Contributor Author

I just filed an issue here: #89

@andrenatal andrenatal added this to the W6 milestone Feb 10, 2022
@andrenatal andrenatal changed the title Incorporate proper readme and architeture docs Incorporate proper readme and architecture docs Feb 10, 2022
@andrenatal andrenatal mentioned this issue Mar 2, 2022
7 tasks
@andrenatal andrenatal modified the milestones: W6, W7 Mar 11, 2022
@andrenatal andrenatal modified the milestones: W7, W8 Mar 22, 2022
@eu9ene
Copy link
Collaborator

eu9ene commented Mar 22, 2022

I have a draft of the Sequence diagram for message flow on paper. It helps a lot to understand communication between components. We can use something like https://mermaid-js.github.io/mermaid/#/ or https://github.com/plantuml/plantuml with simple text notation to make it editable.

@andrenatal andrenatal modified the milestones: W8, W9 Mar 29, 2022
@andrenatal andrenatal removed this from the W9 milestone Apr 7, 2022
@andrenatal andrenatal added the bug Something isn't working label Apr 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants