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

Add links to docs from mode descriptions #2116

Merged
merged 2 commits into from
Apr 12, 2019
Merged

Conversation

amedina
Copy link
Member

@amedina amedina commented Apr 12, 2019

Once the user dismisses the welcome banner there is no persistent links back to the site guiding users to documentation sources. Adding links back to development workflow guidance will help users when engaging with the template mode settings.

@googlebot googlebot added the cla: yes Signed the Google CLA label Apr 12, 2019
@amedina amedina requested a review from westonruter April 12, 2019 05:31
@swissspidy
Copy link
Collaborator

I'd suggest using sprintf() here and using placeholders for the actual URLs. It's a general best practice thing because this way, if the URLs to the documentation change at any point for some reason, the strings don't have to change, meaning all the translations will still be valid.

Example:

/* translators: %s: URL to the documentation. */
$native_description = sprintf( __( 'Integrates AMP as the framework for your site by using the active’s theme templates and styles to render AMP responses. This means your site is <b>AMP-first</b> and your canonical URLs are AMP! Depending on your theme/plugins, a varying level of <a href="%s">development work</a> may be required.', 'amp' ), 'https://amp-wp.org/documentation/developing-wordpress-amp-sites/' );

@westonruter westonruter added this to the v1.1 milestone Apr 12, 2019
@westonruter westonruter merged commit 5154868 into develop Apr 12, 2019
@westonruter westonruter deleted the amedina/link-to-docs branch April 12, 2019 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Signed the Google CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants