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

Appsody.dev Development guide should include how to add links to Markdown #362

Open
helenmasters opened this issue Nov 12, 2019 · 0 comments
Assignees
Labels
webdev Improvements or additions to the website

Comments

@helenmasters
Copy link
Contributor

helenmasters commented Nov 12, 2019

We don't currently have an example of how contributors should add links to other docs on the website into the Appsody Markdown files. We should add this into our Development guide as there is currently confusion over whether the links should be "/content/docs/stacks/package.md" or "docs/stacks/package.md" or "docs/stacks/package"

David, please can you resolve this discussion and add the relevant example into the Development guide.

As part of this work please can you also include a comment about which directories within the website you can 'short link' in this way (ie does it only apply to docs/...) as there is a reference to the contributing guide in the stack documentation which has a fully qualified link which is confusing as that doc is in GitHub website repo

@helenmasters helenmasters added the webdev Improvements or additions to the website label Nov 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
webdev Improvements or additions to the website
Projects
None yet
Development

No branches or pull requests

2 participants