Skip to content

Created "Manage model inventory custom fields" page in Guides#199

Merged
validbeck merged 8 commits intomainfrom
noosheenvazinkhoo/sc-4186/documentation-as-a-customer-admin-i-am-able
May 23, 2024
Merged

Created "Manage model inventory custom fields" page in Guides#199
validbeck merged 8 commits intomainfrom
noosheenvazinkhoo/sc-4186/documentation-as-a-customer-admin-i-am-able

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 23, 2024

Internal Notes for Reviewers

For sc-4186, there was a gap in our documentation for configuring custom fields before rich text editor templates could be referenced, so we created "Manage model inventory custom fields" page under Guides.

Manage model inventory custom fields

  • Net new page
  • Hyperlink in sidebar is shortened, should say: Manage inventory custom fields
Screenshot 2024-05-23 at 10 50 58 AM

Guides:

Added the new Manage model inventory custom fields page to the listings:
Screenshot 2024-05-23 at 10 51 09 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label May 23, 2024
@validbeck validbeck self-assigned this May 23, 2024
@validbeck validbeck requested a review from nrichers May 23, 2024 17:58
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 23, 2024 •
edited
Loading

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ noosheenv
✅ validbeck
❌ noosheen vazinkhoo

noosheen vazinkhoo seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 23, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 3 committers have signed the CLA.

✅ validbeck
❌ noosheen vazinkhoo
❌ noosheenv

noosheen vazinkhoo seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented May 23, 2024

@nrichers Just a quick change to the page to add a Delete custom fields section as Rod confirmed that's possible.

See attached PDF for new page: Manage model inventory custom fields.pdf

nrichers
nrichers approved these changes May 23, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM after comments are addressed. A few suggestions relate to tech writing best practices — e.g. explaining the user action rather than UI behavior — let me know if you want to chat more about these.

@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented May 23, 2024

One other, small comment: I would put "Register models in the inventory" first — pushed ab7323e to that effect.

image

@validbeck validbeck force-pushed the noosheenvazinkhoo/sc-4186/documentation-as-a-customer-admin-i-am-able branch from ab7323e to b96ae46 Compare May 23, 2024 20:44
@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented May 23, 2024 •
edited
Loading

@nrichers I adjusted these changes locally then pushed them instead as I had to accommodate for Rod's quick work on PR-#771 as well!

EDIT: Currently live on the demo-site: https://docs-demo.vm.validmind.ai/guide/manage-inventory-custom-fields.html

@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented May 23, 2024

Nice

@nrichers I adjusted these changes locally then pushed them instead as I had to accommodate for Rod's quick work on PR-#771 as well!

I plan to publish the docs site later today with the release notes. I'll wait for this PR to get merged.

@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented May 23, 2024

FYI, copying changes manually and force pushing should not be necessary — just do a git pull on your working branch to get the latest commits from GitHub.

@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented May 23, 2024

FYI, copying changes manually and force pushing should not be necessary — just do a git pull on your working branch to get the latest commits from GitHub.

Oh yeah, I had just made changes before I saw your contributions so I already had a divergence 💀

@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented May 23, 2024

Oh yeah, I had just made changes before I saw your contributions so I already had a divergence 💀

One of the hallmarks of git & GitHub is decentralized collaboration, so resolving divergence is as simple as merging in changes. It's literally what the thing was made for.

Great talk by Linus Torvalds on the motivation behind git: https://youtu.be/idLyobOhtO4?si=3pZvZe9LKjTJgSlA

@validbeck validbeck merged commit 96ce934 into main May 23, 2024
@nrichers nrichers deleted the noosheenvazinkhoo/sc-4186/documentation-as-a-customer-admin-i-am-able branch May 23, 2024 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nrichers nrichers nrichers approved these changes

Assignees

@validbeck validbeck

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@validbeck @CLAassistant @nrichers @noosheenv