1. STAEDEAN documentation guidelines and processes
  2. Documentation processes
  3. Flows

Publish documentation to docs.staedean.com
Activity Flow

This flow explains all activities to be done to publish STAEDEAN documentation for D365 F&SCM products to the docs.staedean.com/ website.

Note: Always publish the websites from the TI-10-DOCS VM!

Technical writer Technical writer Start Start Publish websites Publish websites You can publish the STAEDEAN product documentation as a website. You can publish: The STAEDEAN Documentation main landing page: docs.steadean.com. Usually, you only do so if a pillar reference is added or removed. A full pillar documentation website. Usually, you do so if a new product tile is added to the pillar website setup. You can also do so if for several pillar products the documentation is updated. Then it's easier to just re-publish the whole pillar website. A product tile for a specific product. You can do this if for only one product the documentation is updated. As a result, the website (or tile) is published to a ZIP file. Procedure 1. Click Business process file share. 2. Click Websites. 3. Sub-task: Publish main website. 4. In the list, find and select the 'STAEDEAN Documentation' website. 5. Click Publish. 6. Click Publish website. 7. Click OK. 8. Sub-task: Publish full pillar website. 9. In the list, select the desired pillar website. 10. Click Publish. 11. Click Publish website. 12. Click OK. 13. Sub-task: Publish tile. 14. In the list, click the link of the desired pillar website. 15. Click the Tiles tab. 16. In the list, find and select the desired tile. 17. On the Tiles tab, click Publish solution. 18. Click OK. Download and test websites locally Download and test websites locally On publishing the website (or a tile), the website content is added to a ZIP file. Download the ZIP file from D365 F&SCM and extract it. Test the published website locally before publishing it to the web! Procedure 1. Click Business process management. 2. Click the All files tab. 3. In the list, find and select the ZIP file for the published website or tile. 4. Click Download. 5. Extract the downloaded ZIP file to a local folder. 6. Open the folder to which the website content is extracted. 7. Find and double-click the 'index.html' file. 8. Browse the opened website and focus on the latest changes that you made to the documentation. Is everything coming/showing alright? Notes Save a back-up of the published website ZIP file. To do so, go to your Downloads folder and move the downloaded ZIP file to the 'STAEDEAN Documentation' team in Teams, to the General channel, to the Files > STAEDEAN Docs Backup > Website backup folder. Publish website to Azure storage explorer Publish website to Azure storage explorer Use the Microsoft Azure Storage Explorer to copy the documentation website content files to the 'sadocswebsite' Azure storage account. This storage account is located in the To-Increase Production environment in Azure. Copy the website contents to this container: Blob Containers\$web. If you are: Updating the main website (docs.staedean.com), delete the 'Resources' folder and the 'index.html' file from the Blob Containers\$web container. Then copy the same folder and file from the unzipped website folder. Updating a full pillar website, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder. Updating the documentation for only one product, open the applicable pillar folder in the Blob Containers\$web, and delete the relevant product folder. The copy the new relevant product folder from the unzipped website folder.  Adding the documentation for a new product, update the full related pillar website. To do so, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder. Updating the full release notes website, delete the 'Release notes' folder from the Blob Containers\$web container. Then copy the full new 'Release notes' folder from the unzipped website folder. Updating the release notes for only one pillar, open the 'Release notes' folder in the Blob Containers\$web, and delete the relevant pillar folder. The copy the new relevant pillar folder from the unzipped website folder.  If you do not have access to this storage account, contact the system administrator. Picture of the Storage explorer showing the $web container contents: Purge and refresh Purge and refresh To properly update the documentation website, do these actions on Microsoft Azure, in the To-Increase Production environment: Purge cache and refresh the 'docsfrontdoor' endpoint. Refresh 'RG_DOCSWEBSITE' resource group. Refresh 'sadocswebsite' storage account. Check published website Check published website If the updated documentation is published to Azure, check if the updates are shown properly on the documentation website. If you do not see the changes, use F5 to refresh the page. If this doesn't work, use Ctrl+F5. If you still do not see the updates, check if all updates are published properly and if the purge and refresh are done properly. Inform the team that the website is updated/published Inform the team that the website is updated/published When the documentation is published to docs.staedean.com, inform the team. End End

Activities

Name Responsible Description

Publish websites

Technical writer

You can publish the STAEDEAN product documentation as a website.

You can publish:
  • The STAEDEAN Documentation main landing page: docs.steadean.com. Usually, you only do so if a pillar reference is added or removed.
  • A full pillar documentation website. Usually, you do so if a new product tile is added to the pillar website setup. You can also do so if for several pillar products the documentation is updated. Then it's easier to just re-publish the whole pillar website.
  • A product tile for a specific product. You can do this if for only one product the documentation is updated.
As a result, the website (or tile) is published to a ZIP file.

Download and test websites locally

Technical writer

On publishing the website (or a tile), the website content is added to a ZIP file.

Download the ZIP file from D365 F&SCM and extract it.

Test the published website locally before publishing it to the web!

Publish website to Azure storage explorer

Technical writer

Use the Microsoft Azure Storage Explorer to copy the documentation website content files to the 'sadocswebsite' Azure storage account. This storage account is located in the To-Increase Production environment in Azure.

Copy the website contents to this container: Blob Containers\$web.
If you are:
  • Updating the main website (docs.staedean.com), delete the 'Resources' folder and the 'index.html' file from the Blob Containers\$web container. Then copy the same folder and file from the unzipped website folder.
  • Updating a full pillar website, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder.
  • Updating the documentation for only one product, open the applicable pillar folder in the Blob Containers\$web, and delete the relevant product folder. The copy the new relevant product folder from the unzipped website folder. 
  • Adding the documentation for a new product, update the full related pillar website. To do so, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder.
  • Updating the full release notes website, delete the 'Release notes' folder from the Blob Containers\$web container. Then copy the full new 'Release notes' folder from the unzipped website folder.
  • Updating the release notes for only one pillar, open the 'Release notes' folder in the Blob Containers\$web, and delete the relevant pillar folder. The copy the new relevant pillar folder from the unzipped website folder. 
If you do not have access to this storage account, contact the system administrator.
Picture of the Storage explorer showing the $web container contents:

Purge and refresh

Technical writer
To properly update the documentation website, do these actions on Microsoft Azure, in the To-Increase Production environment:

Check published website

Technical writer

If the updated documentation is published to Azure, check if the updates are shown properly on the documentation website.

If you do not see the changes, use F5 to refresh the page. If this doesn't work, use Ctrl+F5.
If you still do not see the updates, check if all updates are published properly and if the purge and refresh are done properly.

Inform the team that the website is updated/published

Technical writer

When the documentation is published to docs.staedean.com, inform the team.

Activities

Name Responsible Description

Publish websites

Technical writer

You can publish the STAEDEAN product documentation as a website.

You can publish:
  • The STAEDEAN Documentation main landing page: docs.steadean.com. Usually, you only do so if a pillar reference is added or removed.
  • A full pillar documentation website. Usually, you do so if a new product tile is added to the pillar website setup. You can also do so if for several pillar products the documentation is updated. Then it's easier to just re-publish the whole pillar website.
  • A product tile for a specific product. You can do this if for only one product the documentation is updated.
As a result, the website (or tile) is published to a ZIP file.

Download and test websites locally

Technical writer

On publishing the website (or a tile), the website content is added to a ZIP file.

Download the ZIP file from D365 F&SCM and extract it.

Test the published website locally before publishing it to the web!

Publish website to Azure storage explorer

Technical writer

Use the Microsoft Azure Storage Explorer to copy the documentation website content files to the 'sadocswebsite' Azure storage account. This storage account is located in the To-Increase Production environment in Azure.

Copy the website contents to this container: Blob Containers\$web.
If you are:
  • Updating the main website (docs.staedean.com), delete the 'Resources' folder and the 'index.html' file from the Blob Containers\$web container. Then copy the same folder and file from the unzipped website folder.
  • Updating a full pillar website, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder.
  • Updating the documentation for only one product, open the applicable pillar folder in the Blob Containers\$web, and delete the relevant product folder. The copy the new relevant product folder from the unzipped website folder. 
  • Adding the documentation for a new product, update the full related pillar website. To do so, delete the applicable pillar folder from the Blob Containers\$web container. Then copy the full new pillar folder from the unzipped website folder.
  • Updating the full release notes website, delete the 'Release notes' folder from the Blob Containers\$web container. Then copy the full new 'Release notes' folder from the unzipped website folder.
  • Updating the release notes for only one pillar, open the 'Release notes' folder in the Blob Containers\$web, and delete the relevant pillar folder. The copy the new relevant pillar folder from the unzipped website folder. 
If you do not have access to this storage account, contact the system administrator.
Picture of the Storage explorer showing the $web container contents:

Purge and refresh

Technical writer
To properly update the documentation website, do these actions on Microsoft Azure, in the To-Increase Production environment:

Check published website

Technical writer

If the updated documentation is published to Azure, check if the updates are shown properly on the documentation website.

If you do not see the changes, use F5 to refresh the page. If this doesn't work, use Ctrl+F5.
If you still do not see the updates, check if all updates are published properly and if the purge and refresh are done properly.

Inform the team that the website is updated/published

Technical writer

When the documentation is published to docs.staedean.com, inform the team.
Related to Notes

Publish release notes website

 		 

Publish documentation to docs.staedean.com

 		 

See also