docs: improve consumability and accuracy of fscloud doc #47
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
vburckhardt requested review from SirSpidey, daniel-butler-irl and maheshwarishikha 
SirSpidey suggested changes Mar 1, 2023
Contributor
SirSpidey left a comment
SirSpidey left a comment There was a problem hiding this comment.
@vburckhardt A bunch of style suggestions. Let me know if it's too hard to commit these suggestions and I can make a PR to this PR instead.
| @@ -1,12 +1,15 @@ | |||
| # Financial Services Cloud profile example | |||
| # Financial Services Cloud Profile Example | |||
Contributor
There was a problem hiding this comment.
profile and example should not be capitalized. The title should stay as it was
| | ||
| ############################################################################## | ||
| # Postgres Instance | ||
| # Postgres Instance (FsCloud Profile) |
Contributor
| @vburckhardt wanted to make sure you saw my comments on this PR. It has been open for a week. |
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Co-authored-by: Allen Dean <allen.dean@us.ibm.com>
Contributor
| @vburckhardt checking in again on this open PR. I see that you made some updates. What is left (besides addressing conflicts)? |
SirSpidey added a commit that referenced this pull request May 10, 2023
Pulls in the changes from the open PR #47
Contributor
| @vburckhardt Does the |
13 tasks
Contributor
| Updates included in #186 |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Description
Improve consumability and accuracy of fscloud doc
Addresses #48
Types of changes in this PR
No release required
Release required
x.x.X): Change that fixes an issue and is compatible with earlier versions)x.X.x): Change that adds functionality and is compatible with earlier versions)X.x.x): Change that is likely incompatible with previous versions)Release notes content
Replace this text with information that users need to know about the bug fixes, features, and breaking changes. This information helps the merger write the commit message that is published in the release notes for the module.
Checklist for reviewers
Merge actions for mergers
Merge by using "Squash and merge".
Use a relevant conventional commit message that is based on the PR contents and any release notes provided by the PR author.
The commit message determines whether a new version of the module is needed, and if so, which semver increment to use (major, minor, or patch).