Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Add SeeAlso #59

Closed
camerons opened this issue Nov 30, 2019 · 7 comments · Fixed by #186
Closed

Add SeeAlso #59

camerons opened this issue Nov 30, 2019 · 7 comments · Fixed by #186
Assignees
Labels
improve For any suggestions about how to make templates better. template-howto For all issue relating to the How To Templates template-tutorial For all issue relating to the Tutorial Templates

Comments

@camerons
Copy link
Member

camerons commented Nov 30, 2019

Doc: template-howto
Deepti Korwar
18:37 15 Nov
[Add] A new section called Related resources to capture related how-to guides or articles?

Paul Foxworthy
14:16 14 Nov
... In addition, "Next Steps", "See Also" might be useful

@camerons camerons added improve For any suggestions about how to make templates better. template-howto For all issue relating to the How To Templates template-tutorial For all issue relating to the Tutorial Templates labels Nov 30, 2019
@camerons
Copy link
Member Author

camerons commented Nov 30, 2019

Doc:template-tutorial

Tamanna Sethi
14:42 14 Nov
Consider Adding references to How to article template.
Deepti Korwar
18:45 15 Nov
Add links to other related tutorials or advanced tutorials on the same concept.

@Dishebh
Copy link
Contributor

Dishebh commented May 26, 2020

@camerons I would like to work on it. Can you please give some more insights? Do I have to add a See Also section at the bottom that refers to other similar sections on the same concept?

@camerons
Copy link
Member Author

You can find the source comments in https://drive.google.com/drive/u/1/folders/1He_WbY7qEzCVs1ub9nLQhrL8GOoogy5d
To address this issue, a tech writer should consider the feedback, assess whether it is value, look for other best practices to refer to, and use it to provide a recommendation in the solution.

@camerons
Copy link
Member Author

camerons commented Dec 2, 2020

This should probably go in the base template too.

@acpkendo acpkendo self-assigned this Dec 2, 2020
@barbaricyawps
Copy link
Contributor

Don't forget that it needs to be included in the raw template, but also the explanation of how to use the template. :)

@acpkendo
Copy link
Contributor

acpkendo commented Dec 2, 2020

The team seemed to agree that this is useful, we'll add to the base template and applicable individual templates. And, as @barbaricyawps mentions above, in the about/how-to file for each.

@viraji
Copy link
Contributor

viraji commented Dec 4, 2020

Thanks @acpkendo - as I'm working on another PR for the base template, I can include this as well, myself - shall I?

@acpkendo acpkendo linked a pull request Jan 27, 2021 that will close this issue
6 tasks
barbaricyawps added a commit that referenced this issue Jan 21, 2022
An initial commit for "See also" in How-to. (Resolves #59)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
improve For any suggestions about how to make templates better. template-howto For all issue relating to the How To Templates template-tutorial For all issue relating to the Tutorial Templates
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants