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.

Sign up for GitHub

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

Jump to bottom

Integrate our apps with Help Scout #5

Open
2 tasks
javieralaves opened this issue Nov 25, 2019 · 8 comments
Open
2 tasks

Integrate our apps with Help Scout #5

javieralaves opened this issue Nov 25, 2019 · 8 comments
Assignees
@stellarmagnet @topocount @javieralaves
Labels
documentation Improvements or additions to documentation epic
Milestone
Sprint B3

Comments

@javieralaves
Copy link
Contributor

javieralaves commented Nov 25, 2019 •
edited
Loading

Description

Provide more information across apps with Help Scout documentation.

Acceptance criteria

  • Approve the new documentation material
  • Submit a PR to aragon/help with the new documentation for Open Enterprise apps

Product specs

Available in HackMD.

Minor note: I haven't covered the Projects app in this update, since it's undergoing considerable change at the moment.
@javieralaves javieralaves added epic documentation Improvements or additions to documentation labels Nov 25, 2019
@javieralaves javieralaves added this to the Sprint 3 milestone Nov 25, 2019
@javieralaves javieralaves added the product spec A product spec is needed label Nov 25, 2019
@javieralaves javieralaves self-assigned this Nov 27, 2019
@stellarmagnet stellarmagnet changed the title Improved information on apps Integrate our apps with Help Scout Dec 2, 2019
@stellarmagnet stellarmagnet modified the milestones: Sprint B2, Sprint B3 Dec 3, 2019
@javieralaves
Copy link
Contributor Author

@stellarmagnet I've covered specs for help components across the other epics (see 'Acceptance criteria' and the links I've inserted). And for the Help Scout coverage, do you think we could simply submit a PR with the same content as we currently have on GitBook?

@javieralaves
Copy link
Contributor Author

javieralaves commented Dec 12, 2019 •
edited
Loading

@stellarmagnet I've uploaded the GitBook documentation to a HackMD file so that I could format it almost entirely as HTML, since this is the required format that the PR needs to be in. All apps except Projects, since we'll likely have to update that documentation section over the next weeks as we finalize the upcoming enhancements. Everything's available on the Drive document ready for review.

Note: Images add the Help Scout border by default once uploaded, there's no additional image formatting required.

@javieralaves javieralaves removed the product spec A product spec is needed label Dec 12, 2019
@javieralaves
Copy link
Contributor Author

I will verify the help components myself and remove these from this epic since they are unrelated to Help Scout.

@javieralaves
Copy link
Contributor Author

@stellarmagnet Refined version of the documentation is ready for review. Contrasting this with the specifications in open-enterprise#1211, this update only covers part of it. Maybe we want to do additional tickets for more documentation coverage next sprint? (i.e. permissions per app in-depth)

@javieralaves
Copy link
Contributor Author

Going over Yalda's latest comments over the next hours.

@javieralaves
Copy link
Contributor Author

Nearly done with the changes, just need to wait a few more hours for a couple more screens dependent on executing a dot vote.

@javieralaves
Copy link
Contributor Author

@stellarmagnet Ready for your review again, made changes to language and updated all the images. Also, I added the Budget detail view which got recently deployed.

@javieralaves
Copy link
Contributor Author

@stellarmagnet Did you have a chance to look at the updated documentation? Are we ready to push a pull request on Aragon Help Desk?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stellarmagnet stellarmagnet

@topocount topocount

@javieralaves javieralaves

Labels
documentation Improvements or additions to documentation epic
Projects
None yet
Milestone
Sprint B3
Development

No branches or pull requests
3 participants
@stellarmagnet @topocount @javieralaves