1. STAEDEAN documentation guidelines and processes
  2. Documentation processes
  3. Publish documentation for D365 F&SCM

Set up and maintain docs.staedean.com website

To publish documentation to the website, the website setup must be up to date.

Note: Set up and maintain the to-be-published websites on the TI-10-DOCS VM! The current TI-10-DOCS VM is: https://ti-10-docs4a7b1204826a3ce9devaos.cloudax.dynamics.com/


Technical writer Technical writer Start Start Website setup Website setup Usually, you only change the website setup to add documentation for a new solution. This topic gives an explanation on how the STAEDEAN documentation website is set up. In RapidValue, this websites setup is used for the docs.staedean.com website: The main website: SATEDEAN Documentation (https://docs.staedean.com/). This website is the SATEDEAN product documentation landing page for the STAEDEAN solutions for D365 F&SCM. A sub-website for each of the pillars. Each pillar website is the landing page for the pillar documentation with references to the documentation of each pillar solution: Data Management (https://docs.staedean.com/data/) Equipment Rental (https://docs.staedean.com/rental/) Manufacturing (https://docs.staedean.com/manufacturing/) Other (https://docs.staedean.com/others/) Release notes (https://docs.staedean.com/Release%20notes/index.html) Note: The Life Sciences documentation is published on a different platform/website. This is managed by the Life Sciences team. The docs.staedean.com landing page has a reference to the Life Sciences documentation. Pictures of the STAEDEAN documentation websites setup Picture of the websites: Picture of the STAEDEAN Documentation website tiles: Picture of the Data Management website tiles: Picture of the Equipment Rental website tiles: Picture of the Manufacturing website tiles: Picture of the Others website tiles: Picture of the required Details setting for each tile: Procedure 1. Click Business process file share. 2. Click Websites. New D365 F&SCM  product documentation to  be added to the website? New D365 F&SCM  product documentation to  be added to the website? Add product icon to website resources Add product icon to website resources Each STAEDEAN product for D365 F&SCM, add a tile to the applicable pillar website setup. Each product tile has it's own icon. Ask the marketing department for the appropriate icon for the product tile. Procedure 1. Click Business process file share. 2. Click Websites. 3. In the list, click the link of the applicable pillar website. 4. Click Edit. 5. Expand the Resources section. 6. Click ResourcesDownload. 7. Extract the downloaded Resources ZIP file. 8. Copy the product icon in PNG format to the ...\Resources\images folder. 9. Zip the Resources folder. Note: Make sure you zip the right Resources folder! After extracting, it can be that you get a ../Resources/Resource/ folder structure. Zip the last Resource folder in the path. 10. Upload the new Resources ZIP file to the website. Notes Make sure to save a backup of the created Resources.zip file in the 'STAEDEAN Documentation' team in Teams, the General channel, the Files > STAEDEAN DOCS backup > Website backup folder.  Add tile for new D365 F&SCM product Add tile for new D365 F&SCM product Each STAEDEAN product for D365 F&SCM has it's own tile in the applicable pillar website setup. When you add documentation for a new product, also add a new tile. Procedure 1. Click Business process file share. 2. Click Websites. 3. In the list, find and select the desired record. 4. In the list, click the link in the selected row. 5. Click the Tiles tab. 6. Click Add tile. 7. In the Solution field, enter or select a value. 8. In the Title field, type a value. 9. In the Custom image URL field, enter the URL for the image. 10. Edit the description which is defaulted from the solution description. Make it as short as possible. For example, max 2-3 sentences. This is the text that is shown at the right of the tile icon on the website. 11. Click the Detail tab. 12. Select the Show navigation pane check box. 13. Select the Enable external feedback check box. 14. In the Owner field, enter 'STAEDEAN Documentation'. 15. In the Owner email field, enter 'customeroperations@staedean.com'. 16. Select Yes in the Show table of contents pane field. Notes Use the existing tiles detail settings as a reference on how the Detail fields must be filled in. See also this picture: End End Did you make changes  to the website setup? Did you make changes  to the website setup? Make backup of website setup Make backup of website setup When you have made changes to the website setup, make a backup of the changed website setup. Procedure 1. Click Business process file share. 2. Click Websites. 3. In the list, find and select the desired record. 4. On the Action Pane, click Manage. 5. In the list, find and select the desired record. 6. Click Export. 7. In the Content package field, add the current date to the default content package name, for example between parentheses. 8. Click OK. 9. Close the page. 10. Refresh the page. 11. On the Business process file share workspace, on the Content packages tab, select the created content package. Note: Tip: Copy the content package name to make creating the data file quicker. 12. Click Create data file. 13. In the File name field, type a value. Note: Tip: Paste the copied content package name. 14. Click OK. 15. Click the Data files tab. 16. Select the data file that is created for the website setup and click Download. Note: Go to your Downloads folder and move the downloaded data file to the 'STAEDEAN Documentation' team in Teams, to the General channel, to the Files > STAEDEAN DOCS backup > Website backup folder. Yes No Yes No

Activities

Name Responsible Description

Website setup

Technical writer

Usually, you only change the website setup to add documentation for a new solution.

This topic gives an explanation on how the STAEDEAN documentation website is set up.

In RapidValue, this websites setup is used for the docs.staedean.com website:
  • The main website: SATEDEAN Documentation (https://docs.staedean.com/). This website is the SATEDEAN product documentation landing page for the STAEDEAN solutions for D365 F&SCM.
  • A sub-website for each of the pillars. Each pillar website is the landing page for the pillar documentation with references to the documentation of each pillar solution:
    • Data Management (https://docs.staedean.com/data/)
    • Equipment Rental (https://docs.staedean.com/rental/)
    • Manufacturing (https://docs.staedean.com/manufacturing/)
    • Other (https://docs.staedean.com/others/)
  • Release notes (https://docs.staedean.com/Release notes/index.html)

Note: The Life Sciences documentation is published on a different platform/website. This is managed by the Life Sciences team. The docs.staedean.com landing page has a reference to the Life Sciences documentation.

Pictures of the STAEDEAN documentation websites setup

Picture of the websites:

Picture of the STAEDEAN Documentation website tiles:

Picture of the Data Management website tiles:

Picture of the Equipment Rental website tiles:

Picture of the Manufacturing website tiles:

Picture of the Others website tiles:

Picture of the required Details setting for each tile:

Add product icon to website resources

Technical writer

Each STAEDEAN product for D365 F&SCM, add a tile to the applicable pillar website setup. Each product tile has it's own icon.

Ask the marketing department for the appropriate icon for the product tile.

Add tile for new D365 F&SCM product

Technical writer

Each STAEDEAN product for D365 F&SCM has it's own tile in the applicable pillar website setup.

When you add documentation for a new product, also add a new tile.

Make backup of website setup

Technical writer

When you have made changes to the website setup, make a backup of the changed website setup.