Skip to content

Comments

Getting started cleanup#891

Open
mike-scott wants to merge 3 commits intofoundriesio:mainfrom
mike-scott:getting-started-cleanup
Open

Getting started cleanup#891
mike-scott wants to merge 3 commits intofoundriesio:mainfrom
mike-scott:getting-started-cleanup

Conversation

@mike-scott
Copy link
Contributor

Fix some "easy" issues with our Getting Started documentation.

  • Drop the CI selection page. Too complicated for a Getting Started guide.
  • Move fioctl installation and build/deploy application pages out a level so that they apply to both the container-only and lmp-based workflows
  • Fixup the title (grammar) for the "Building and Deploying an Application" page

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.
You may delete items that are not relevant to your contribution.
Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck, and add redirects for any moved or deleted pages.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

This is confusing for the Community Edition users.  We can address
it in the Github documentation.

Signed-off-by: Michael Scott <mike@foundries.io>
These 2 items are specific to using a Factory with an LmP-based device.
We also need these for the container-only workflow.

Signed-off-by: Michael Scott <mike@foundries.io>
Signed-off-by: Michael Scott <mike@foundries.io>
Copy link
Contributor

@Tim-Anderson Tim-Anderson left a comment

Choose a reason for hiding this comment

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

LGTM

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.

2 participants