18f / guides-template Goto Github PK
View Code? Open in Web Editor NEWJekyll template for 18F Guides, based on CFPB/DOCter
Home Page: https://guides-template.18f.gov/
License: Other
Jekyll template for 18F Guides, based on CFPB/DOCter
Home Page: https://guides-template.18f.gov/
License: Other
Basically, it can't scroll.
via Control Masonry
Chrome is showing .nav-children with a max-hight: 400px;. This is limiting the number of controls showing up in the rendered pages. There is currently no overflow setting, either. The end result is it appears many controls are missing after the page generation.
.nav-children {
display: block;
max-height: 400px;
opacity: 1;
-webkit-transition: max-height .2s, opacity .2s;
-moz-transition: max-height .2s, opacity .2s;
-o-transition: max-height .2s, opacity .2s;
transition: max-height .2s, opacity .2s;
}
Best solution might be an overflow: scroll;.
Start at https://pages.18f.gov/guides/, see the link, go to the link to the template.
On https://pages.18f.gov/guides-template/, most of the stuff in the introduction doesn't make sense to me. Do I need to know it? It's also confusing why there are so many instructions to update an existing guide (unless the issue is that old guides don't have the new fancy stuff). In any case, I see that I should go to the Readme and go there!
On https://github.com/18F/guides-template/blob/18f-pages/README.md, is there a way to check if I have Ruby? (Will knows he has Ruby , is not sure if others will). It's also not clear if I can do the same by forking the repo on GitHub - will that work? (Discussion ensued on Slack, this is addressed later in the process but an update to instructions might be helpful?)
(Run the brew commands, get slightly freaked out by the number of edited formulas)
Hit an error when trying to clone, #42 addresses this.
I think access Localhost and am a little confused that I am now supposed to work down the side lists (vs "updating an existing guide" - I wonder if that is the next step since my guide exists. However, I figure it out and start working my way down the lieft hand columns
https://pages.18f.gov/guides-template/adding-a-new-page/ is not newbie friendly, but I think that's ok given the fact that this isn't a training on "how to work a GitHub repo". I do just fine.
https://pages.18f.gov/guides-template/updating-the-config-file/ is slightly confusing because the "Once you're finished updating the config file, click the GitHub Setup entry in the table of contents." text is above everything else. I'll submit a PR to clarify that: #44
Also on that page, I am not sure what the description of my repo should be (also, at that point, I might not know the URL). Maybe add a note that explains that the user can some back to this after publishing on GitHub, or to use their repo's name as the root?
I also think we should add instructions to modify the "back link" if appropriate since this should fall under 18F Pages, not 18F Guides. And, the Google Analytics link was already set - can that instruction be removed?
On https://pages.18f.gov/guides-template/updating-the-config-file/understanding-baseurl/, it's not clear me when this should come up - when I'm creating new pages? I haven't made a new page yet, so this is confusing.
On https://pages.18f.gov/guides-template/github-setup/, same issue as config file - the top bit is a bit clearer though. I think the command to run ./go create_repo is confusing because I thought I already had a repo....oh, now I see in doing it that it creates a whole new one! Neat!
As I create my new repo, I don't know if I should edit .gitignore or "add a license." I will assume not. I make the new repo an ignore the instructions (that part isn't quite clear, that I can ignore everything on that page)
Everything works great for putting the repo on the 18F org and adding the webhook. I make some local changes (and run into an issue where I don't have a contributing.md file - Mike B is fixing in #46). I also delete most of the content on index.md and push a commit up using GitHub for Mac! It all worked!
People who are reading one guide might not know that we have other handy documents on different topics. It would be nice to have a away back to the main guide list page (https://pages.18f.gov/guides/) from any interior page of any guide, but certainly from the landing page for each guide (https://pages.18f.gov/agile/ https://pages.18f.gov/content-guide/ etc).
Perhaps it could go either in the footer, or up top under the blue header line?
The style should probably be the same as for the team page:
Add an optional function that would allow guide content to be downloaded as a single, well-formatted PDF. This has been requested by users as a way to bring guides to management in meetings who wouldn't see them otherwise.
As this is currently structured, the template being updated won't be reflected in the individual guides.
Since this is a guide that must be followed in order and with every step, I think the left nav should be an ordered list and then we can remove the "Now go to the next step" from the bottom of each section. Thoughts?
master
instead of 18f-pages
18f-pages
and Pages in this repoon https://pages.18f.gov/joining-18f/ theres an issue with the menu. I noticed that when there are highlighted lists like job descriptions or interview breakdowns, the blue highlight on the menu disappears. This makes it particularly difficult if you're looking at in on the phone. Any help in fixing this, I would be much obliged!
From an email I received about the content guide:
I like the 18F content style guide very much. I just wish it was easier to read.
I know that the Federal government is not required to follow WCAG 2.0 accessibility standards yet, but designers could still have some compassion for those of us with aging eyes.
The WCAG 2.0 guideline for contrast is a ratio of 4.5:1. The contrast in the left navigation bar is 1.9:1. The text is better but still difficult to read without effort.
This fad of minimalist sites with grey on white can't end soon enough for me.
For the Before You Ship site, which uses this gem, I was trying to figure out a good way to include a script on every page of the site. Since the layout is embedded in the gem, I wasn't able to modify it directly. I ended up figuring out a workaround using a nested layout (see _config.yml
and _layouts/default.html
in 18F/before-you-ship#71), but it feels like a bit of a hack. Curious if there are other ideas about how to accomplish this?
/cc @fureigh
Can we add the 18F favicon to the template so whenever a new guide is created, it has the 18F icon on tabs?
Got this when running ./go serve.
Corrected by running bundle install
.
Referenced here: 18F/open-source-guide#10
Govfresh published an article about the open source guide and suggested that we include a "Submit feedback" on each page- which would direct people to the repo's issues next to "edit this page", which directs people to the edit function for each page. I think this would be a good addition to the guides.
Hi Folks - Curious if anyone knows of a similar "guide" template that has the Web Design standards baked in? It seems the Design Standards docs themselves are largely modeled on this theme.
Basically, I'm looking to create up a content-focused Jekyll site that matches the styles of the Design Standards docs. Forking the design standards is one way forward, but I'd prefer to start with a "blank slate" that is similar to this template. Thanks for any pointers!
I imagine a lot of (people we want to be) Guide creators won't be comfortable with the command line...would be good to provide a less intimidating path for them.
We rewrote the Agile guide (agile.18F.gov). What do I do to replace what's there now?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.