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

feat(#1360): Document how to configure Android App Link verification #1366

Merged
merged 20 commits into from
May 9, 2024

Conversation

m5r
Copy link
Member

@m5r m5r commented Apr 25, 2024

Description

#1360

License

The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.

@m5r m5r linked an issue Apr 29, 2024 that may be closed by this pull request
12 tasks
@m5r m5r marked this pull request as ready for review April 29, 2024 22:26
@m5r m5r requested review from jkuester and sugat009 April 29, 2024 22:26
@m5r
Copy link
Member Author

m5r commented Apr 29, 2024

@jkuester @sugat009 could you take a look at the docs for setting up medic/cht-android#308 ?
Feel free to point out/add anything I might have missed

Copy link
Contributor

@jkuester jkuester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice and detailed! I left a few comments about content and structuring of the docs within the site, but here is my overall vision:

  • General overview of deep linking functionality (especially from a user's perspective) should go in features/integrations/android
  • The technical instructions for how to create your assetlinks.json file and how to verify that deep links work with your app/instance should go in guides/android (either in a new page or as a section of guides/android/branding.
  • An overview of the assetlinks.json file structure, its location and usage in the config should go in reference/app-settings/assetlinks.

With the right linkage connecting everything I think this would communicate the right things to the right people in the right places. (Open to other ideas here though!)

I have been working on testing these steps locally, but ran out of time today and did not want to block the rest of this review. I will leave another comment tomorrow regarding how my tests went!

content/en/apps/reference/app-settings/assetlinks.md Outdated Show resolved Hide resolved
content/en/apps/reference/app-settings/assetlinks.md Outdated Show resolved Hide resolved
content/en/apps/reference/app-settings/assetlinks.md Outdated Show resolved Hide resolved
content/en/apps/reference/app-settings/assetlinks.md Outdated Show resolved Hide resolved
content/en/apps/features/integrations/android.md Outdated Show resolved Hide resolved
content/en/apps/features/integrations/android.md Outdated Show resolved Hide resolved
content/en/apps/features/integrations/android.md Outdated Show resolved Hide resolved
content/en/apps/features/integrations/android.md Outdated Show resolved Hide resolved
content/en/apps/reference/app-settings/assetlinks.md Outdated Show resolved Hide resolved
@jkuester
Copy link
Contributor

jkuester commented May 1, 2024

Just following up to say I was successfully in getting this process to work end-to-end, starting from scratch with a new Android flavor by following this documentation! In particular, the verification instructions were very handy when I typoed my package name and was trying to debug what was going wrong!

All in all, this is a tricky process, but this documentation is solid and makes it very straight forward to get things setup!

@m5r m5r requested a review from jkuester May 7, 2024 11:14
Copy link
Contributor

@jkuester jkuester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Had a few minor thoughts that I left inline, but all in all we have some solid documentation here!

content/en/apps/features/integrations/android.md Outdated Show resolved Hide resolved
content/en/apps/guides/android/branding.md Outdated Show resolved Hide resolved
content/en/apps/reference/app-settings/_index.md Outdated Show resolved Hide resolved
content/en/apps/guides/android/branding.md Show resolved Hide resolved
@m5r m5r merged commit 58dc697 into main May 9, 2024
2 checks passed
@m5r m5r deleted the 1360-document-android-app-link-verification branch May 9, 2024 14:20
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

Successfully merging this pull request may close these issues.

Document how to configure Android App Link verification
3 participants