Code Monkey home page Code Monkey logo

collections-publisher's Introduction

Collections Publisher

The Collections Publisher publishes:

These pages are then served by the collections app.

Screenshot of Collections Publisher

Live examples

Nomenclature

See the README of collections frontend.

Technical documentation

This is a Ruby on Rails application for internal use by GDS and some departmental editors.

It has these features:

  • Creating & editing topics and mainstream browse pages.
  • Creating & editing step by step navigation pages, and where they are used as sidebar and sticky navigation.
  • Curate the pages tagged to a topic or browse page into "curated lists". This means they'll be displayed in a group with a title. By default, the links are not curated and will appear with a 'A-Z' heading.

Screenshot of curated and non-curated pages

Left, a curated mainstream browse page, right, an uncurated browse page.

Screenshot of a step by step navigation page

Example of a step by step navigation page.

Screenshot of step by step navigation sidebar

Example of step by step navigation used as sidebar navigation for one of the primary pages.

This application uses the sidekiq message queue for background work (mainly publishing to the Publishing API).

Dependencies

  • alphagov/publishing-api -
    • used for the publishing workflow of mainstream_browse_pages, topics, curated lists and step_by_step_pages.
    • Publishing API sends data onto Rummager for search indexing topic, mainstream_browse_page and step_by_step_page pages.

Running the test suite

The test suite includes testing against govuk-content-schemas, so you will need a copy of this repo on your file system. By default this should be in a sibling directory to your project. Alternatively, you can specify their location with the GOVUK_CONTENT_SCHEMAS_PATH environment variable.

To run the test suite:

bundle exec rake

Licence

MIT License

collections-publisher's People

Contributors

agadufrat avatar alex-ju avatar alext avatar barrucadu avatar bishboria avatar brucebolt avatar carvil avatar cbaines avatar chrisbashton avatar davidslv avatar deborahchua avatar dependabot-preview[bot] avatar dependabot-support avatar dilwoarh avatar elliotcm avatar jackscotti avatar jonathanhallam avatar jonodrew avatar jordanhatch avatar kevindew avatar kushalp avatar leenagupte avatar murilodalri avatar rboulton avatar selfthinker avatar sihugh avatar suzannehamilton avatar thomasleese avatar tijmenb avatar tomsabin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.