Skip to content

Commit 5032ad6

Browse files
authored
Update DEV-README.md
Added more instructions with walk through videos for updating website
1 parent f79cae6 commit 5032ad6

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

docs/DEV-README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,30 @@ See [Swell's release page](https://github.com/open-source-labs/Swell/releases) f
243243
---
244244
## How can I update [Swell's website](https://getswell.io/) after the iteration?
245245

246-
The website is hosted on AWS, which means you will need credentials to access the files (in S3 buckets) for the latest version of the website. You will need to contact OS Labs for the credentials, or if you are iterating the product as part of a Codesmith program they should have access to the information needed.
246+
The website is hosted on AWS, which means you will need credentials to access the files (in S3 buckets) for the latest version of the website. You will need to contact OS Labs for the credentials, or if you are iterating the product as part of a Codesmith program they should have access to the information needed. You also will need to invalidate the previous distribution to ensure your modifications are properly deployed. See gifs below on how to accomplish this.
247+
248+
249+
1. Uploading a new index.html file
250+
[Modifying the index.zip](https://github.com/open-source-labs/Swell/files/12423736/Modifying.the.index.zip)
251+
252+
- Ensure you repeat this process for both getswell.io and www.getswell.io as both are public access points to the website.
253+
- It might be easier to create a new index.html file on your own code editor, download the current index.html file and transfer the entire document to your newly created index.html file and continue to modify as needed.
254+
- You do not need to delete the old versions of the index.html file it will automatically update to your newly modified file.
255+
256+
257+
2. Uploading Contributor Images on S3 Bucket
258+
[Updating images.zip](https://github.com/open-source-labs/Swell/files/12423737/Updating.images.zip)
259+
260+
- Ensure you repeat this process for both getswell.io and www.getswell.io buckets as both are viable public access points
261+
- Ensure matching file types and names between the /img/SwellTeamPics/<your_img> and the index.html src attribute.
262+
263+
3. Invalidate previous distribution
264+
[Invalidation Workflow.zip](https://github.com/open-source-labs/Swell/files/12423739/Invalidation.Workflow.zip)
265+
266+
- This process should be done after you have finalized all your modifications
267+
268+
269+
247270

248271
Things to consider updating:
249272

@@ -258,5 +281,5 @@ Things to consider updating:
258281

259282
This should serve as an entry point for any developers who wish to iterate on Swell and therefore, should be kept as up-to-date as possible. **At the end of your iteration, you are strongly encouraged to update this document for future developers.**
260283

261-
Thank you for your consideration and let's work on making Swell one of the best open-source products to contribute!
284+
Thank you for your consideration and let's work on making Swell one of the best open-source products to contribute![UpdateContImgs.gif.zip]
262285

0 commit comments

Comments
 (0)