swiftlang / swiftlang/docs

docs migration - Deploying to DigitalOcean

Open
#57 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content migration
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Description

Source: documentation/server/guides/deploying/digital-ocean.md
Proposed disposition: Migrate
Proposed destination: server-guides/Sources/ServerGuides.docc/deploying/digital-ocean.md
Reviewer: @swiftlang/server-workgroup

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate) and confirm destination
  • Review source for accuracy against current DigitalOcean Droplet configuration options
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify all DigitalOcean console steps are current
  • Add article to ServerGuides.docc/Documentation.md under a "Deployment" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in server-guides/
  • Preview locally with swift package --disable-sandbox preview-documentation in server-guides/
  • Submit PR to this repository for server workgroup review
  • After merge and publication: add redirect_to: in the swift.org source file's front matter
  • Submit redirect PR to swift-org-website

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with documentation/server/guides/deploying/digital-ocean.md and compare it with the target server-guides/Sources/ServerGuides.docc/deploying/digital-ocean.md location. Review the DigitalOcean steps, convert the documented Jekyll content, and add the article to ServerGuides.docc/Documentation.md under a Deployment topic group. Run the two listed documentation commands in server-guides/; completion also requires the post-publication source redirect and redirect PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.