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

Add templates for version replacements #879

Closed
Dr-Electron opened this issue Feb 20, 2023 · 1 comment · Fixed by #922
Closed

Add templates for version replacements #879

Dr-Electron opened this issue Feb 20, 2023 · 1 comment · Fixed by #922
Assignees
Labels

Comments

@Dr-Electron
Copy link
Collaborator

Dr-Electron commented Feb 20, 2023

Is your feature request related to a problem? Please describe.

To minimise the problems with merging different version, we should provide variables that replace certain templates so that merging docs won't be a problem (see examples at the end of this issue)

Describe the solution you'd like

We maybe could use rehype-lodash-template or a similar tool to have a list of templates/variables that in the docs will be replaced with the corresponding strings.

For urls this may also be of help: rehype-url-inspector (It could even help with broken links)

Describe alternatives you've considered

Doing it manually :trollface:

Additional context

In the docs you could for example use ${ENVIRONMENT_URL}/hornet/welcome which in a Shimmer environment would point to https://wiki.iota.org/shimmer/hornet/iota.org (or even better use the config parameters) and in an IOTA environment to https://wiki.iota.org/hornet/iota.org

Or another markdown example:

In ${NETWORK} you always need a storage deposit

where ${NETWORK} will be replaced with either IOTA or Shimmer

@Dr-Electron Dr-Electron moved this to Product Backlog in Developer Experience Mar 30, 2023
@Dr-Electron Dr-Electron self-assigned this Mar 30, 2023
@annie101101046 annie101101046 moved this from Product Backlog to Sprint Backlog in Developer Experience Mar 30, 2023
@Dr-Electron Dr-Electron moved this from Sprint Backlog to In Progress in Developer Experience Apr 7, 2023
@Dr-Electron
Copy link
Collaborator Author

Blocked because I can't get it to work as this is an ESM module and Docusaurus doesn't like me 😢

Normally this should work like described in the note here: https://docusaurus.io/docs/markdown-features/plugins#installing-plugins

If this doesn't work with this plugin we would need to wait for official ESM support. (Which maybe already comes with version 3.0 which should be the next release 🤔 )

@Dr-Electron Dr-Electron moved this from In Progress to Blocked in Developer Experience Apr 13, 2023
@github-project-automation github-project-automation bot moved this from Blocked to Done in Developer Experience Apr 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant