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.

Sign up for GitHub

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

Jump to bottom

Document linking scheme for external contributors #69

Open
johnaxel opened this issue Mar 7, 2018 · 0 comments
Open

Document linking scheme for external contributors #69

johnaxel opened this issue Mar 7, 2018 · 0 comments

Comments

@johnaxel
Copy link
Contributor

johnaxel commented Mar 7, 2018

Some of our articles contain internal links to other Datadog pages and articles, e.g.

/blog/monitoring-101-collecting-data/

These links won't work from within Github, and they can be confusing to external contributors (see for example #68), so we should either:

  1. Standardize on full, functional URLs for source files (though this has some drawbacks for us while the posts are in development/staging)
  2. Document clearly why we're doing what we're doing with links and other quirks so that well-meaning contributors don't spend time fixing them
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johnaxel