Skip to content

docs: fixes rendering of parameter table in docs for app desc and deployment#184

Open
singhmj-1 wants to merge 1 commit into
pre-draftfrom
docs/169-fix-param-attrib
Open

docs: fixes rendering of parameter table in docs for app desc and deployment#184
singhmj-1 wants to merge 1 commit into
pre-draftfrom
docs/169-fix-param-attrib

Conversation

@singhmj-1
Copy link
Copy Markdown
Contributor

Description

The docs rendered for application-description and application-deployment show name object to be an explicit field in parameters object (a key:value map), whereas it refers to the key attribute of the map.

Issues Addressed

Closes #169

Change Type

Please select the relevant options:

  • Fix (change that resolves an issue)
  • New enhancement (change that adds specification content)
  • Content edits (change that edits existing content)

Checklist

  • I have read the CONTRIBUTING document.
  • My changes adhere to the established patterns, and best practices.

…loyment

Closes #169

Signed-off-by: Manjinder <manjinder.b.singh@capgemini.com>
@singhmj-1 singhmj-1 self-assigned this May 22, 2026
@singhmj-1 singhmj-1 requested a review from a team as a code owner May 22, 2026 08:47
@singhmj-1
Copy link
Copy Markdown
Contributor Author

Fixes for application description:

image image

Fixes for application deployment:

image image

@Silvanoc
Copy link
Copy Markdown
Contributor

This PR makes a moving target for the Data Model PR #158. The hereby introduced changes should be also made in the branch of PR #158.

@chrisgclayton
Copy link
Copy Markdown

Looking at the images vs. the actual files, which I assume are snapshots of the actual files I noticed there is a "typo" I assume in Image 1. You will notice it says in the description of parameters:
e.g., e.g., (doubled up).

I get that this passed the SUP stage I assume so it is more of a question than asking for a change.

Moving something from a formal field (i.e., metadata.name) to a property bag key/value typically implies there are not special rules of processing associated with it etc. I would assume that a formal name would have some guardrails? Also is there not special meaning to it? It feels like movement from formal to property bag is generalizing something that should not be? (again please take this as a question as I was not involved at the time of the SUP)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify name parameter within the parameter attributes section of the application description.

3 participants