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

[DOCS] Improve "asset links" section in android.md by replacing <URL to your PWA> by <Host URL of your PWA> #4832

Closed
clementlize opened this issue Oct 14, 2024 · 2 comments · Fixed by #4833

Comments

@clementlize
Copy link
Contributor

What's your suggestion for improvement for our docs?

Let's say my app is deployed on https://example.com/development.app

In the Android section of the site builder, I would fill these fields:

I would then want to set the "asset links" to remove the Chrome URL top bar, so going to the documentation I see this:

To properly deploy this file, upload it to your server at https://<URL to your PWA>/.well-known/assetlinks.json.

So I'd go to my hosting and create the file at www/development.app/.well-known/assetlinks.json where www is the root folder of my web server. I would then test the URL https://example.com/development.app/.well-known/assetlinks.json and see that I can get the file from my browser.

But the URL app would not disappear!

In fact, the Android app expects this file to be located in a .well-known directory directly under the host domain.
So I move my file to www/.well-known/assetlinks.json (full URL is now https://example.com/.well-known/assetlinks.json ) and it works now.

I think it would be better to include this host precision in the documentation. The line in android.md would become:

To properly deploy this file, upload it to your server at https://<Host URL of your PWA>/.well-known/assetlinks.json.

Do you have an implementation or a solution in mind?

No response

Have you considered any alternatives?

No response

Copy link
Contributor

This issue has been marked as "needs attention 👋" since it has not been triaged for 7 days. Please triage the issue .

1 similar comment
Copy link
Contributor

This issue has been marked as "needs attention 👋" since it has not been triaged for 7 days. Please triage the issue .

github-merge-queue bot pushed a commit that referenced this issue Oct 29, 2024
#4833)

fixes #4832 
<!-- Link to relevant issue (for ex: "fixes #1234") which will
automatically close the issue once the PR is merged -->

## PR Type
<!-- Please uncomment one ore more that apply to this PR -->

<!-- - Bugfix -->
<!-- - Feature -->
<!-- - Code style update (formatting) -->
<!-- - Refactoring (no functional changes, no api changes) -->
<!-- - Build or CI related changes -->
- Documentation content changes
<!-- - Sample app changes -->
<!-- - Other... Please describe: -->


## Describe the current behavior?
<!-- Please describe the current behavior that is being modified or link
to a relevant issue. -->

> To properly deploy this file, upload it to your server at
`https://<URL to your PWA>/.well-known/assetlinks.json`.

## Describe the new behavior?

> To properly deploy this file, upload it to your server at
`https://<Host URL of your PWA>/.well-known/assetlinks.json`.

## PR Checklist

- [ ] Test: run `npm run test` and ensure that all tests pass
- [ ] Target main branch (or an appropriate release branch if
appropriate for a bug fix)
- [ ] Ensure that your contribution follows [standard accessibility
guidelines](https://docs.microsoft.com/en-us/microsoft-edge/accessibility/design).
Use tools like https://webhint.io/ to validate your changes.


## Additional Information

Co-authored-by: Justin Willis <jgw9617@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants