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

Research possible solutions for centralizing common documentation links #1730

Open
3 tasks
steve-todorov opened this issue Apr 9, 2020 · 2 comments
Open
3 tasks

Research possible solutions for centralizing common documentation links #1730

steve-todorov opened this issue Apr 9, 2020 · 2 comments
Labels
documentation good first issue

Comments

@steve-todorov
Copy link
Member

Task Description

Our documentation is using mkdocs-material which generates our website at https://strongbox.github.io/. Since we are using reference links in the docs, it should be, in theory, possible to create a sort of meta markdown page which we can include into other markdown pages. This will reduce the time we would need to spend at fixing internal/external links which could change at any time.

Essentially the idea is to have a markdown page called shared-reference-links.md which contains something like this:

[<!-- Global links which can be shared across all pages such as links to JDK8, system requirements, etc -->]: # 

[<!-- Strongbox related links -->]: # 
[strongbox-distribution-setup]: ./user-guide/getting-started.md
[hello-strongbox-gradle]: https://github.com/strongbox/strongbox-examples/tree/master/hello-strongbox-gradle
[other-commonly-used-referenced-link]: ./developer-guide/some-page.md

[<!-- External links (grouped by domain, sorted by logic or alphanumerical) -->]: # 
[<!-- Gradle links -->]: #
[gradle-homepage]: http://gradle.org/
[gradle-artifact-management]: https://docs.gradle.org/current/userguide/artifact_management.html
[gradle-build-environment]: https://docs.gradle.org/current/userguide/build_environment.html
[gradle-plugins]: https://docs.gradle.org/current/userguide/plugins.html
[gradle-using-tasks]: https://docs.gradle.org/current/userguide/tutorial_using_tasks.html
[spring-gradle-example]:https://spring.io/guides/gs/gradle/

Once you include it into a page you could then simply do:

You need to setup a [Strongbox distribution instance][strongbox-distribution-setup]

and it should result in a correct link:

You need to setup a Strongbox distribution instance

Tasks

The following tasks will need to be carried out:

  • Research for any possible solutions
  • Make a list of the ones which are likely to work with their pros/cons
  • After we decide on a solution - create a new task.

Notes

Help
@aaryan078
Copy link

i would like to work on this

@aaryan078
Copy link

please explain me what i have to do i am confuse somewhat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@carlspring @steve-todorov @aaryan078