open-horizon.github.io

open-horizon.github.io copied to clipboard

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

Most of the pages in the Open Horizon Website has title"Open Horizon". So, I want to add related title wrt. page content. Like this page title should "Overview- Open Horizon".

Add Feedback Option in the page as discusssed here .

Two comments:

1. Let's ensure that the name "Open Horizon is not embedded into the page. We should instead be using variable insertion everywhere we can. This means either the variable that is an absolute reference to the open source project, or the variable that could mean the current product, which may be a downstream distribution. LMK if that's not clear and you need more details.
2. Let's get some feedback from @Rene-Ch1 to ensure that this change will not negatively impact downstream consumption of our documents.

@joewxboy yes, this point is bit unclear to me about variable.

@joewxboy yes, this point is bit unclear to me about variable.

OK, buckle up. :)

We use GitHub Pages (GHP) to generate our documentation from markdown files. We have configured GHP in the Open Horizon project to use Jekyll as the Static Site Generator (SSG), and Liquid as the templating engine. Therefore, all variable interpolation follows Liquid syntax.

The data that populates variables is stored in _data in the keyword.yml file as a hash/dictionary/associative array. The reason for using variables is at least three-fold:

1. It allows us to store important information that may change (like version numbers) in a single place for easy updating.
2. It allows us to remove proper names so that they don't get translated.
3. It allows downstream documentation adopters to use their own terminology without re-writing the docs merely by using their own keyword.yml file.

Variable values are populated in this sequence or order of precedence:

• First, from keyword.yml file
• Second, from a page's front matter
• Third, from inline default values or assignments

You'll notice in the keyword file that many variables contain "Open Horizon". This is intentional and each serves a unique purpose. For example, edge_notm (edge solution name, no trademark symbol) is "Open Horizon". This should likely always have a value of "Open Horizon" since it refers to the open source project solution. The variable ieam also contains "Open Horizon". However, this variable should be used for the adopter's product name. In the case of Open Horizon, the value is "Open Horizon", but in the case of IBM's Edge Application Manager, it is "IEAM". Therefore, it is important to use the appropriate variable name in a markdown file to ensure that the end result is what you'd expect.

In the case of a page title, we'd likely want to use something like page.title - ieam. Notice that there isn't a "page.title" in the keywords.yml file. That's because it doesn't make sense to put a default title value for every page on the site. Instead, we populate each page's title in the page's front matter. That's what the page. prefix is for, as opposed to site. which pulls from the keyword.yml file.

This is a very short explanation, and I've skipped a lot of details. Hopefully it's enough to give you the broad strokes of what you need to know. I'd also request that once you get a handle on the information, that you flesh out the brief description I just gave into a longer and more user-friendly version that we can pass on.

@joewxboy Ya its clear now. Sorry for late reply.

@joewxboy This issue is not completed still, that pr was one of the patch..Please reopen this.

@Sukriti-sood re-opened per your request.

@Sukriti-sood re-opened per your request.

Thanks 🙌🏻

@joewxboy i think this issue is outdated because of the migration to the new theme?

OK, these issues are now addressed by the new theme and the updating of the front matter. Closing.