Giter Club home page Giter Club logo

paas-product-page's Introduction

GOV.UK PaaS Product Page

⚠️ This repository is the old iteration of the product pages. The new product pages are located at alphagov/paas-product-pages ⚠️


This is the source for the PaaS product page at https://www.cloud.service.gov.uk/

It is a Ruby/Sinatra app that makes use of the GOV.UK Elements, Frontend Toolkit and Template libraries.

Configuration

The following environment variables should be set for correct deployment:

variable required description
ZENDESK_URL yes endpoint url (ie "https://accountname.zendesk.com/api/v2")
ZENDESK_USER yes user for the api
ZENDESK_TOKEN yes token for the api
ZENDESK_GROUP_ID no group id to send the tickets to

Development

Dependencies:

  • Ruby
  • Bundler

You will find:

  • The main application is ./app.rb
  • General content page in ./views/
  • Sass files in ./assets/stylesheets (these will auto compile in dev mode)

To start the server locally in development mode:

ZENDESK_USER='REDACTED' \
ZENDESK_TOKEN='REDACTED' \
ZENDESK_URL=https://govuk.zendesk.com/api/v2 \
ZENDESK_GROUP_ID=123456789 \
make dev

To print the tickets to stdout rather than send to zendesk

FAKE_ZENDESK='true' \
make dev

Deploying changes

This application should not be manually deployed to production. A pipeline in alphagov/paas-release-ci will automatically deploy changes to the master branch.

You may wish to manually deploy this application to a different environment in order to test some changes. We've provided a release script for both build and push for your convinience.

Check in your changes to master.

$ ./release/push

Note: you will need the correct PaaS permissions as well as target your desired organisation and space.

paas-product-page's People

Contributors

36degrees avatar 46bit avatar alext avatar ap-hunt avatar bandesz avatar benh-gds avatar camelpunch avatar chris-moreton avatar combor avatar dcarley avatar dependabot[bot] avatar gemmaleigh avatar henrytk avatar jollery avatar jonathanglassman avatar jonty avatar keymon avatar leeporte avatar lukemalchergds avatar markpeterbuckley avatar mcmillan avatar nooshu avatar paroxp avatar pauldougan avatar quis avatar richardtowers avatar samcrang avatar sheryllgds avatar tomskerous avatar whi-tw avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

paas-product-page's Issues

ensure there are linkable targets to all sections of the product page

As an architect working with other government departments and delivery partners I need go be able to signpost people to the most specific guidance in our product material on the use of our platform. Typically this requires the ability to refer to specific topics in email, slack, gsuite, hangouts etc.

To make sure we can point people to our material we should ensure that there are linkable targets to all the sub headings of the product documentation so that we can link to specific sections of the docs.

The tech docs does this well.

<h2 id="standard-buildpack-responsibilities" class="anchored-heading">
<a href="#standard-buildpack-responsibilities" class="anchored-heading__icon" aria-hidden="true" tabindex="-1"></a>
Standard buildpack responsibilities</h2>

For example, we now document the platform constraints at https://www.cloud.service.gov.uk/constraints

I need to be able to link to a specific section like https://www.cloud.service.gov.uk/constraints#faas

so that we I direct users to the most specific guidance possible when explaining the topic

to: [email protected]
subject: GOV.UK PaaS and FaaS

The GOV.UK PaaS does not support the 'functions as a service' style of application, 
see  https://www.cloud.service.gov.uk/constraints#faas
  • Add targets to the sections in a way that is compatible with the design system
  • test links

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.