Skip to content

Plan and document how we keep the site up to date #7

Description

@iangilman

A very important aspect of the website is ongoing maintenance. We need that to be as smooth as possible, or it will fall into disrepair. Key areas I'm aware of:

  • Releasing a new build
  • Adding/updating plugins
  • Adding/updating "In the Wild" links
  • Adding/updating "Creating zooming images" links

Releasing a new build

  • We host a copy of the latest OSD on the site; we should continue to do that. This can be handled with something like the current grunt publish from the main OSD repository.
  • We need to build the documentation from the JSDoc comments in the code from the latest release. Currently that happens in the site-build repository, but theoretically that could happen here in the website repository. Actually, it could be good for it to happen in the main OSD repository; that would make it easier for people to test the docs while they are in development.

I believe that this new website code currently grabs the latest JSDoc comments from the main OSD repository. We shouldn't be doing that, as it will make the documentation out of sync with the released code.

Adding/updating content

  • Pulling the data for our various lists (such as plugins) out of the HTML and turning them into JavaScript arrays is perfect for this. That's what's already happening in this new website, so we're probably all good on that front.

Documenting the procedures

Maybe that should go in markdown files in this project? Either that or we can start a wiki here.

For reference, here's the "releasing a new build" procedure documentation currently:

https://github.com/openseadragon/site-build/wiki/Build-Procedure

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions