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

Add placeholders system to have global variables in markdown #1425

Conversation

NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented May 9, 2019

PR description

Add placeholders system to have global variables in markdown

Implement and configure a first batch of variables for versions to be changeable
in only one place and change in the whole doc.

Applied these variables in some places in the docs where I thought it was interesting to have non fixed values.

Available placeholders are :
{{ versions.pantheon_stable }} -> the latest stable release
{{ versions.quickstart }} -> the latest quickstart release which is currently
pointing to the same value as Pantheon as QS and Pantheon releases are in sync
but I still keep two separated values to make it clear.

What ? It's not dynamically updated when we create a release ?
-- Don't worry, of course it's the next step and it involves some CI pipelines changes. To be continued then in a next PR.

Why all these files are modified 😱?
-- This PR also includes few fixes like removing $ in front of bash commands and changed an
info block syntax. I should have fixed that in a separate PR, I admit...

Fixed Issue(s)

fixes PIE-1374

…rkdown

implement and configure a first batch of variables for versions to be changeable
in only one place and change in the whole doc.

available placeholders are :
{{ versions.pantheon_stable }} -> the latest stable release
{{ versions.quickstart }} -> the latest quickstart release whicjh is currently
pointing to the same value as Pantheon as QS and Pantheon releases are in sync
but I still keep two separated values to make it clear.

Also includes few fixes like removing $ in front of bash commands and changed an
info block syntax
@NicolasMassart NicolasMassart added enhancement New feature or request documentation Related to any type of documentation labels May 9, 2019
@NicolasMassart NicolasMassart self-assigned this May 9, 2019
@NicolasMassart NicolasMassart merged commit 3364002 into PegaSysEng:master May 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Related to any type of documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants