From 45869d3599d96251c2e6e96fbcdcb10d960036d6 Mon Sep 17 00:00:00 2001 From: Jessica Schilling Date: Fri, 24 Jul 2020 17:22:17 -0600 Subject: [PATCH] Update readme for changes in update/test/release process --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f0ead9c..01e6a4a 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,47 @@ # dir-index-html -[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai) -[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/) +[![Made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai) +[![Project: IPFS](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/) [![Matrix](https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat-square)](https://matrix.to/#/room/#ipfs:matrix.org) [![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) -> Directory listing HTML for go-ipfs gateways +> Directory listing HTML for `go-ipfs` gateways -This repo is not be used standalone. It's used by the gateway code in go-ipfs. It'll be merged into the gateway package, once the gateway has been extracted from go-ipfs. +**NOTE:** This repo is not intended to be used as a standalone project! This code is used by the gateway code within [`go-ipfs`](https://github.com/ipfs/go-ipfs). In the long term, once the the gateway is extracted from `go-ipfs`, the code in this repo will be merged into that gateway package. ![](https://user-images.githubusercontent.com/157609/88379209-ce6f0600-cda2-11ea-9620-20b9237bb441.png) ## Updating -1. Make changes to _both_ dir-index.html and dir-index-uncat.html. -2. Follow the instructions in [go-ipfs](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index. +When making updates to the directory listing page template, please note the following: + +1. Make your changes to the (human-friendly) source documents in the `src` directory +2. Before testing or releasing, make sure to run the build script to generate a minified version in the `dist` directory: + +```bash +> npm run build +``` +3. To get your updates into `go-ipfs`, you'll need to do the following: + - Cut a new, appropriately versioned release of `dir-index-html` (don't forget to bump the version number in `package.json`) + - Make a PR against `go-ipfs` following [these instructions](https://github.com/ipfs/go-ipfs/tree/master/assets#updating-dir-index-html) for updating the directory index ## Testing -1. Install [go](https://golang.org/dl/). -2. Run the test server: +1. Make sure you have [Go](https://golang.org/dl/) installed +2. Start the test server, which lives in its own directory: ```bash > cd test > go run . ``` +This will listen on [`localhost:3000`](http://localhost:3000/) and reload the template every time you refresh the page. -This will listen on `localhost:3000` and re-load the template every time you refresh the page. +If you get a "no such file or directory" error upon trying `go run .`, make sure you ran `npm run build` to generate the minified artifact that the test is looking for. ## Contribute -Feel free to join in. All welcome. A good place to start is [the issues](https://github.com/ipfs/dir-index-html/issues). +Feel free to join in. All are welcome! A good place to start is to check the [issues](https://github.com/ipfs/dir-index-html/issues) for anything you find interesting. This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). -- GitLab