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

Add contributing docs; steps to fork, clone, add, commit/sign, push to Fermyon Cloud Docs. #34

Merged
merged 7 commits into from
Oct 11, 2022
Merged

Conversation

tpmccallum
Copy link
Collaborator

@tpmccallum tpmccallum commented Oct 10, 2022

This is a quick one-pager which will be useful of developers want to contribute to the Cloud Docs in the future. If nothing else it will be handy to have for our internal team (or when onboarding etc.)

Screen Shot 2022-10-10 at 1 25 18 pm

Screen Shot 2022-10-10 at 1 24 58 pm

Signed-off-by: tpmccallum tim.mccallum@fermyon.com

…myon Cloud Docs.

Signed-off-by: tpmccallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum <tim.mccallum@fermyon.com>
Signed-off-by: tpmccallum <tim.mccallum@fermyon.com>
Copy link
Contributor

@karthik2804 karthik2804 left a comment

Choose a reason for hiding this comment

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

The content looks good to me but as mentioned below, we should possibly standardize how we present shell commands. I just marked one instance of the shell commands for reference.

content/cloud/contributing.md Outdated Show resolved Hide resolved
@mikkelhegn
Copy link
Member

LGTM (Once the shell commands are fixed). I'd like to also get to the requirements for the content of a doc. article. E.g., how shell commands are presented, having a ToC at the top of the article, etc. @tpmccallum Do you think this should go into this doc as well?

@tpmccallum
Copy link
Collaborator Author

Hi @mikkelhegn
I have added a ToC to the top of the document which also links to each section heading.
This can be merged if you are happy with the latest changes.

Signed-off-by: tpmccallum <tim.mccallum@fermyon.com>
@tpmccallum
Copy link
Collaborator Author

Actually have changed the way ToC is created; now using automated tool in VSCode. Thanks @mikkelhegn for suggesting "Markdown All In One" extension. Works well.

Signed-off-by: tpmccallum <tim.mccallum@fermyon.com>
Copy link
Contributor

@karthik2804 karthik2804 left a comment

Choose a reason for hiding this comment

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

LGTM!
Also we should probably do a new commit to add all the required annotations for the codeblocks across the repository (For removing copy button and formatted copy for the shell code blocks)

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.

None yet

3 participants