Code Monkey home page Code Monkey logo

federalist.18f.gov's Introduction

CircleCI Known Vulnerabilities

Federalist documentation

This is an informational site with background on Federalist, a compliant static site publishing service for the federal government.

Setup

Install the dependencies.

$ bundle install

Run the site locally for development.

$ bundle exec jekyll serve

Open your web browser to localhost:4000.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

federalist.18f.gov's People

Contributors

adborden avatar amirahaziz avatar amirbey avatar anjunainaustin avatar apburnes avatar arowla avatar brandocalrissian avatar bryanthales-zz avatar davemcorwin avatar davidewarren avatar dependabot-preview[bot] avatar dependabot[bot] avatar dhcole avatar drewbo avatar eddietejeda avatar el-mapache avatar emileighoutlaw avatar fulldecent avatar hursey013 avatar jmhooper avatar jseppi avatar maya avatar mbland avatar mheadd avatar nkkl avatar ondrae avatar svenaas avatar tbaxter-18f avatar vz3 avatar wslack avatar

Stargazers

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

Watchers

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

federalist.18f.gov's Issues

(WIP) Content to add about editing the main Federalist template

  • The main Federalist template builds pages using layouts with pre-made headers and footers, all created with HTML. These templates cannot be edited though the Federalist editor and must be modified by someone with knowledge of HTML.
  • Some of the text on pages is adjusted using the front matter, not the text editing interface.
  • Pages have titles, filenames, and names in the menu, which can all be configured separately.
  • Files should be uploaded on different branches than those creating links to the files.
  • Uploading files in bulk works best using a GitHub client that syncs between your local machine and GitHub

Document solution for: I want to use a template, and have a repo in the 18F org

I was trying to spin up a new site on federalist today and couldn't figure out how to use one of the provided templates and also connect it to a repo in the 18F org.

Will Slack provided the answer (use the "Use this template/Create this site" button which creates a repo in your personal github account, move your repo from your personal account to the 18F org, delete the site off Federalist, re-add it using the "Or add your own Github repository" option).

It would be great if this workflow was included in the federalist support docs somewhere

Methods Cards as example site

Hey! The methods cards are in Federalist now - might be a good candidate for your list of examples.

homepage screenshot:
screen shot 2017-06-12 at 10 58 09 am

Fix the Custom Template page

This page is old and unclear

The Custom Templates section seems to say it's possible to make custom templates, but how one would do such a thing is hard to understand. Would be nice to make it clear for users who want to go away from the provided templates what the path looks like should they choose to make (1) simply static content, (2) jekyll-built sites, or (3) hugo-built sites.

Responsive break seems too wide

The break for https://federalist-docs.18f.gov/ to switch to a tablet layout seems too wide. If the window is even slightly narrower that full screen on my laptop, the side nav drops to the bottom of the page, which hides a lot of the page content.

This fix is above my technical level, but it seems like the break happens much earlier than on other 18F sites.

Add search to federalist-docs site

I personally am often frustrated by not being able to search our docs website. I often resort to using my code editor's find functionality to search my local clone of this repo. Integrating search in the site itself would be really nice.

I'm not very familiar with the landscape, but I think some options are:

update template page with new template titles

change single page template and multi page template to landing page template and modern team template.

This will make the names the same as on federalist - create a site page as well as the github repos

Add hugo documentation

Now experimental support of hugo has landed in federalist-staging, and will soon be in production, we should update the docs here to include relevant information about using hugo with federalist.

Update federalist-docs to use new guides_style gem

I can't find where in the code/data this is set to file a PR for, but the "Edit this page" link, on the bottom of pages like this one, is broken:

https://federalist-docs.18f.gov/pages/using-federalist/customer-responsibilities/

It links to https://github.com/18F/federalist-docs/edit/18f-pages/pages/using-federalist/customer-responsibilities.md, but the correct link replaces 18f-pages with master.

Also, the text in the footer says "Hosted on 18F Pages", which is now incorrect.

Stop using or reconfigure guides_style on federalist-docs

https://github.com/18F/guides-style forces the "edit this page" link at the bottom to point to an incorrect branch and a Hosted on 18F Pages message. We should reconfigure to avoid these issues or stop using the gem.

I think there are three places in code that call this:

Content guide naming issue

Hello! As @line47 noted over in the 18F Content Guide repo, there is some confusion about the Federalist Content Guide vs. the 18F Content Guide. After some discussion with the content guild, we realized that the "Content guide" within the Federalist docs is actually more about how to use specific templates, rather than general content best practices.

To avoid confusion, we'd like to recommend changing the name of the "Content guide" within the Federalist docs to something else — perhaps "Template guide," "Using the templates," or "Page sections"?

Document that GitHub 2FA is required

We should add documentation that makes it explicitly clear that users must have 2FA enabled for their GitHub account in order to access Federalist

Document Federalist Code Merge Workflow

We don't write down anywhere instructions about how to merge in code-changes. These should be in federalist-docs in the short term and linked from the repo readmes.

Specify value of NODE_ENV when `npm run federalist` is run?

I realized that it'd be nice if my site built using a production configuration when running on Federalist, which made me wonder if NODE_ENV is set to production or anything. If it's not, that's ok--I can just modify my federalist NPM script to e.g. set that environment variable, or something else. But if it does, it'd be nice to document that in the Federalist node docs!

Add a basic diagram to help with Federalist Sales

Description of feature or bug

Someone non-technical that wants to "get" Federalist would do better with a very basic diagram of the entire system.

Definition of done

  • New diagram is added to the docs repo

After evaluating, edit this part:

Level of effort - low

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.