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

Repo sync #33875

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/azure-preview-env-deploy-public.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ jobs:
run: src/workflows/prune-for-preview-env.sh

- name: 'Build and push image'
uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
uses: docker/build-push-action@1a162644f9a7e87d8f4b053101d1d9a712edc18c
with:
context: .
push: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/azure-preview-env-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ jobs:
run: src/workflows/prune-for-preview-env.sh

- name: 'Build and push image'
uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
uses: docker/build-push-action@1a162644f9a7e87d8f4b053101d1d9a712edc18c
with:
context: .
push: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/azure-prod-build-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ jobs:
token: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }}

- name: 'Build and push image'
uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
uses: docker/build-push-action@1a162644f9a7e87d8f4b053101d1d9a712edc18c
with:
context: .
push: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/azure-staging-build-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ jobs:
run: src/early-access/scripts/merge-early-access.sh

- name: 'Build and push image'
uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
uses: docker/build-push-action@1a162644f9a7e87d8f4b053101d1d9a712edc18c
with:
context: .
push: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main-preview-docker-cache.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
run: src/workflows/prune-for-preview-env.sh

- name: 'Build and push image'
uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25
uses: docker/build-push-action@1a162644f9a7e87d8f4b053101d1d9a712edc18c
with:
context: .
push: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptio

## Configuring your watch settings for an individual repository

You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) , or completely ignore an individual repository.
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or completely ignore an individual repository.

{% data reusables.repositories.navigate-to-repo %}
1. In the upper-right corner, select the "Watch" drop-down menu, then click a watch option.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Annotating code examples
shortTitle: Annotating code examples
shortTitle: Annotate code examples
intro: "You can annotate longer code examples to explain how they work and how people can customize them for other uses."
layout: inline
versions:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuring redirects
shortTitle: Configure redirects
intro: "If an article's title, version, or location changes, you can create a redirect to the current content."
versions:
feature: 'contributing'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating diagrams for {% data variables.product.prodname_docs %}
shortTitle: Creating diagrams
shortTitle: Create diagrams
intro: 'This guide explains when and how to create diagrams for {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Creating tool switchers in articles
shortTitle: Creating tool switchers
shortTitle: Create tool switchers
intro: 'You can use a tool switcher to show how to complete tasks using specific tools.'
versions:
feature: 'contributing'
Expand Down
3 changes: 2 additions & 1 deletion content/contributing/writing-for-github-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ versions:
children:
- /best-practices-for-github-docs
- /about-githubs-documentation-philosophy
- /writing-content-to-be-translated
- /content-design-principles
- /writing-content-to-be-translated
- /making-content-findable-in-search
- /versioning-documentation
- /using-markdown-and-liquid-in-github-docs
- /using-yaml-frontmatter
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Making content findable in search
shortTitle: Make content findable
intro: 'Follow these SEO best practices to help users find {% data variables.product.company_short %} documentation using search engines.'
versions:
feature: 'contributing'
---

## About search engine optimization (SEO)

Search engine optimization (SEO) is the practice of earning visibility for web content in search engine results, such as those of Google and Bing. Google search is the top referrer to {% data variables.product.prodname_docs %} and the most common entry point for our users.

We can plan and write our content to improve SEO. Better SEO improves the experience of people searching for documentation because it makes it more likely for them to find the information they seek using their preferred search terms.

## Best practices for content SEO

Good SEO requires planning content for specific audiences and being attentive to the words they use to search. Follow these best practices to improve an article's SEO.

### Select a target audience

Understand and write to the specific audience for the content: developers, administrators, or code learners. This helps you to:

* Use words that your readers use.
* Make content relevant to their needs and tasks.
* Provide the right amount of context and background information.

### Respond to search intent

Craft content around **search intent**: the task, question, or problem that drives a member of the target audience to search for information online.

* Conduct search intent research. For example, analyze search engine results pages (SERPs) for relevant queries.
* Understand user needs. Use multiple sources such as customer feedback, user interviews, and metrics.

### Use clear language

Follow guidance in "[AUTOTITLE](/contributing/writing-for-github-docs/best-practices-for-github-docs)," including:

* Ensure every article has a clear, discrete topic.
* Put higher priority content first in an article.
* Structure articles with clear headings.
* Edit content for consistency following the "[AUTOTITLE](/contributing/style-guide-and-content-model/style-guide)."

### Incorporate keywords

Incorporate keywords, or top search terms used by your audience, into page copy and metadata. For example, if you are writing about "billing" but your audience primarily uses "cost" and "payment," use those terms instead.

Google and Bing both offer keyword research tools to help you discover relevant keywords. The Docs team also consults Google Search Console data to understand what search terms lead to pages on {% data variables.product.prodname_docs %}.

### Include metadata

Use complete metadata in the frontmatter. To see the values available, see "[AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter)."

On {% data variables.product.prodname_docs %}, the `intro` element displays as an on-page subhead and serves as the HTML metadata description. The article title serves as the HTML page title. For good SEO:

* Write the title and `intro` to be complementary and keyword-rich. Consider how they will render in research.
* Accompany all images with keyword-rich alt text, which is also metadata used by search engines. See "[Alt text](/contributing/style-guide-and-content-model/style-guide#alt-text)" in the {% data variables.product.prodname_docs %} Style Guide.

### Link strategically

Link frugally to other task-relevant pages on {% data variables.product.prodname_docs %} and high-quality peer sites, following "[Links](/contributing/style-guide-and-content-model/style-guide#links)" in the {% data variables.product.prodname_docs %} Style Guide.

Ensure that incoming links do not break by carefully maintaining redirects.

### Maintain accuracy

Ensure content is free of errors in fact, spelling, and style. Audit content periodically to remove errors such as broken links and to retire unneeded content. See "[AUTOTITLE](/contributing/writing-for-github-docs/configuring-redirects)."
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Using videos in GitHub Docs
shortTitle: Using videos
shortTitle: Use videos
intro: 'This guide explains how to create videos that support user needs for {% data variables.product.prodname_docs %}.'
versions:
feature: 'contributing'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

* in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**On {% data variables.product.prodname_dotcom %}** option).
* by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email** option).
* on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**CLI** option).
* on the command line. Warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**CLI** option).
* on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#enabling-push-notifications-with-github-mobile)."

{% note %}
Expand Down
Loading
Loading