Skip to content

Commit

Permalink
Update help center content readme file download procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardoaerobr committed Sep 17, 2024
1 parent b454803 commit ded2cf5
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,41 @@
# help-center-content

Repository assembling VTEX's Help Center content

## In this repository

You will find the following folders in this repository:

-TBD

## Contributing with Help Center Portal documentation

We're so glad you're here! Thanks for being interested.

### How do I add a download file to my article?

1. Open a branch in the [help-portal-content](https://github.com/vtexdocs/help-center-content) repository.
2. Copy the file you want to make available for download to the same directory as the article where it will be inserted. For instance, to allow the user to download a spreadsheet within the article **[Payment Provider List](https://github.com/vtexdocs/help-center-content/blob/b454803127cc490362c16921ceee023a5d182409/docs/pt/tutorials/Payments/Payment%20Settings/list-of-payment-providers-by-country.md)**, you need to save it in the directory [vtexdocs/help-center-content/docs/pt/tutorials/Payments/Payment Settings](https://github.com/vtexdocs/help-center-content/docs/pt/tutorials/Payments/Payment_Settings/).
3. Go to the [branches page](https://github.com/vtexdocs/help-center-content/branches), and under **Your branches** section, click on the name of the branch you created.

![Branches_page](https://raw.githubusercontent.com/vtexdocs/help-center-content/readme-download-illustration-1.png)

4. Locate the folder where you saved the file and click on it.

![File_folder](https://raw.githubusercontent.com/vtexdocs/help-center-content/readme-download-illustration-2.png)

5. Right-click on the **Raw** option and select **Copy link address (Copiar endereço do link)**.

![Raw_link_information](https://raw.githubusercontent.com/vtexdocs/help-center-content/readme-download-illustration-3.png)

6. Access the article where you want to add the file and insert the link obtained in the previous step in the desired location.

![Add_link_in_article](https://raw.githubusercontent.com/vtexdocs/help-center-content/readme-download-illustration-4.png)

7. Submit your PR for review.

## Track articles

Track articles' titles must contain the reference numbers in the navigation, but not in the title of the article page.

![image](https://github.com/user-attachments/assets/7409460d-e3b7-473b-8945-f7ff3faa6862)
Binary file added readme-download-illustration-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme-download-illustration-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme-download-illustration-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme-download-illustration-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ded2cf5

Please sign in to comment.