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] Add publish an update guide and other changes #27665

Merged
merged 6 commits into from Mar 29, 2024

Conversation

amandeepmittal
Copy link
Member

@amandeepmittal amandeepmittal commented Mar 14, 2024

Why

This came up recently in a conversation with @brentvatne as we do not have a page where we describe how to publish an update and how it works briefly.

How

In the EAS Update section, this PR:

  • Adds a guide on "How to publish an update"
  • Updates EAS Update introduction with a BoxLink to the above guide
  • Updates EAS Update Get started guide by removing the Step 7 which describes the command to publish and test the update and instead add a next to the above guide

Other changes:

Test Plan

Run docs locally and visit: http://localhost:3002/eas-update/publish/ or see preview: http://docs.expo.dev-pr-27665.s3-website-us-east-1.amazonaws.com/eas-update/publish/.

Checklist

@expo-bot expo-bot added the bot: passed checks ExpoBot has nothing to complain about label Mar 14, 2024
@expo-bot
Copy link
Collaborator

expo-bot commented Mar 14, 2024

📘 Your docs preview website is ready!

docs/pages/eas-update/develop-faster.mdx Outdated Show resolved Hide resolved
docs/pages/eas-update/publish.mdx Outdated Show resolved Hide resolved
docs/pages/eas-update/publish.mdx Outdated Show resolved Hide resolved
docs/pages/eas-update/publish.mdx Show resolved Hide resolved
Co-authored-by: Quinlan Jung <quin@expo.io>

Publishing an update allows:
- Fixing bugs and quickly updating non-native parts of a project instead of creating a new build
- [Sharing a preview version of an app](/review/overview/) using internal distribution
Copy link
Member Author

Choose a reason for hiding this comment

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

@brentvatne, as per your recent feedback, I've added a link to Review > Overview that mentions sharing a preview version.

@amandeepmittal amandeepmittal merged commit e747609 into main Mar 29, 2024
5 checks passed
@amandeepmittal amandeepmittal deleted the aman/add-eas-update-publish-guide branch March 29, 2024 15:13
amandeepmittal added a commit that referenced this pull request Mar 31, 2024
…Extensions tab (#27772)

# Why

<!--
Please describe the motivation for this PR, and link to relevant GitHub
issues, forums posts, or feature requests.
-->

Closes ENG-11705

# How

<!--
How did you build this feature or fix this bug and why?
-->

This PR updates the Use expo-dev-client with EAS Update guide by:
- Adding info on what **Extensions** tab is and how it can be used to
preview an update in a development build
- Move the Construct a specific URL into its own section
- Update introduction to match the contents of the guide and explain
what this guide does for the reader
- Change title of "More" section to "Example" since it only provides a
link to the GitHub example
- Change the title of this doc to "Load a published update with
expo-dev-client and EAS Update" to match the contents of the guide
- Link to publish update guide from #27665 when it mentions about
publishing an update
- Update `BoxLink` description to use inline code syntax highlight for
the library name

# Test Plan

<!--
Please describe how you tested this change and how a reviewer could
reproduce your test, especially if this PR does not include automated
tests! If possible, please also provide terminal output and/or
screenshots demonstrating your test/reproduction.
-->

Run docs locally and visit:
http://localhost:3002/eas-update/expo-dev-client/ or see Preview:
http://docs.expo.dev-pr-27772.s3-website-us-east-1.amazonaws.com/eas-update/expo-dev-client/.

# Checklist

<!--
Please check the appropriate items below if they apply to your diff.
This is required for changes to Expo modules.
-->

- [x] Documentation is up to date to reflect these changes (eg:
https://docs.expo.dev and README.md).
- [x] Conforms with the [Documentation Writing Style
Guide](https://github.com/expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md)
- [ ] This diff will work correctly for `npx expo prebuild` & EAS Build
(eg: updated a module plugin).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: passed checks ExpoBot has nothing to complain about preview
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants