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

Update Content development guide #114

Merged
merged 8 commits into from
Mar 30, 2022
Merged

Conversation

mkuziemko
Copy link

Description

Changes proposed in this pull request:

  • update all the manifests to the most recent ones,
  • fix outdated comments/tools,
  • add, when needed, text related to the storage backend.

Generally, I went through the whole text/examples and update it.

Related issue(s)

@mkuziemko mkuziemko added area/documentation Relates to all activities around documentation area/hub-manifests Relates to Hub manifests labels Mar 16, 2022
@pkosiec pkosiec self-assigned this Mar 17, 2022
@pkosiec pkosiec added the enhancement New feature or request label Mar 17, 2022
Copy link
Member

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really appreciate you updated the content in almost all places (e.g. removing mention of the Argo artifacts issue which is already resolved) 👍 Apart from some minor suggestions, the biggest things I'm missing are:

  • a description of an Argo artifact content, that is: which properties it should have - value, backend fields - to be able to upload it as a TypeInstance. I'm not seeing it anywhere 🤔
  • a short, dedicated section how to use the storage backends from content developer perspective. I mean - really short and concise, so it shouldn't be a big deal 🙂

docs/content-development/guide.md Show resolved Hide resolved
docs/content-development/guide.md Show resolved Hide resolved
docs/content-development/guide.md Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
@mkuziemko mkuziemko added the WIP Work in progress label Mar 23, 2022
@mkuziemko mkuziemko force-pushed the update_guide branch 2 times, most recently from 9744eb7 to b975ddd Compare March 23, 2022 17:23
@mkuziemko mkuziemko removed the WIP Work in progress label Mar 23, 2022
Copy link
Member

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure that all manifests are up to date according to our main branch on hub-manifests (including the unpackValue: true` from jinja) and apply all changes. Then it will be ready to be merged 👍

docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Outdated Show resolved Hide resolved
Copy link
Member

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please apply last two comments and we can merge it 🚀

docs/content-development/guide.md Outdated Show resolved Hide resolved
docs/content-development/guide.md Show resolved Hide resolved
@mkuziemko mkuziemko merged commit b9a6778 into capactio:main Mar 30, 2022
@mkuziemko mkuziemko deleted the update_guide branch March 30, 2022 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Relates to all activities around documentation area/hub-manifests Relates to Hub manifests enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants