Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update primercss.io website #315

Closed
wants to merge 12 commits into from
Closed

Update primercss.io website #315

wants to merge 12 commits into from

Conversation

broccolini
Copy link
Member

@broccolini broccolini commented Aug 13, 2017

Make primercss.io a 1 page overview & archive old website

It's been killing me for a while that we have such an out of date public website. Most primer modules have up-to-date style documentation that is a lot more useful than the out of date website, and it's probably not very obvious to people that those docs are there.

We're making good progress on the new documentation website and our intention was to make primercss.io a 1 pager of information with links to install and overview of packages, and then link to the new style guide documentation. This update sets us up for that.

In this pr

  • archives old site, with link to it in case people still want to access it
  • makes primercss.io a 1 page overview with summary of packages, links to all the useful things such as installation instructions, the changelog, and all the modules.
  • uses latest primer-css styles

This is what it looks like:
-users-broccolini-repos-primer-css-index html

For a more robust implementation we should automate the list of modules in each meta-package as well as version numbers. I think this static page will do for now, but we could probably make this a jekyll site and borrow some of the scripts we're using in the new documentation to keep this up-to-date.

⚠️ This pr should not be shipped until we ship the 9.3.0 release which will contain the remaining documentation and consolidated changelog.

To do

  • move site to it's own repo
  • check the css maps correctly to the archived site - cc @jonrohan for halp with this
  • Ship primer-css 9.3.0
  • update favicon to new blue

cc @primer/design-systems

@mdo
Copy link
Contributor

mdo commented Aug 13, 2017

Is the intent to host any future Primer documentation on this site, or is it all going in our upcoming styleguide redesign?

@broccolini
Copy link
Member Author

@mdo The intention is to host all style documentation and design guidelines in the new style guide, and for primer.io to be a 1 page overview of packages, and perhaps installation instructions, and to link to the style guide from there.

Copy link
Member

@jonrohan jonrohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a few /archive prefix links


<title>
Home &middot; Primer
</title>

<link rel="stylesheet" href="/docs.css">
<link href="https://unpkg.com/primer-core/build/build.css" rel="stylesheet">
<link href="https://unpkg.com/primer-markdown/build/build.css" rel="stylesheet">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say not to rely on unpkg.com and just check in these build sources into this branch

Home &middot; Primer
</title>

<link rel="stylesheet" href="/docs.css">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be /archive/docs.css

</footer>
</div>

<script src="/js/anchor.min.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs /archive

<h1>Primer</h1>
<p>The CSS toolkit and guidelines that power GitHub.</p>

<a href="/scaffolding/" class="btn btn-reverse">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs /archive


<nav class="masthead-nav">
<a href="/scaffolding">Docs</a>
<a href="/about">About</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs /archive

</a>

<nav class="masthead-nav">
<a href="/scaffolding">Docs</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs /archive


<header class="masthead">
<div class="container">
<a href="/" class="masthead-logo">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs /archive ?

<link rel="stylesheet" href="/docs.css">

<!-- Favicons -->
<link rel="apple-touch-icon-precomposed" href="/img/apple-touch-icon-precomposed.png">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good, but you moved the icon to archive. I think you should move it back since the new single page has it also.

@broccolini
Copy link
Member Author

Thanks @jonrohan - I realized I didn't map any of the urls and meant to comment, will fix those up.

@broccolini broccolini mentioned this pull request Sep 1, 2017
28 tasks
@broccolini
Copy link
Member Author

@jonrohan @shawnbot I tried adding a package.json on this branch and installing primer but it gets "confused" and picks up node modules for dependencies from other branches (such as lerna and storybook). I think it might be better to move the website to it's own separate repo, that would also allow us to use gh pages to publish storybook or other pages that we want to look nice (the readme or /docs folder can be published and it uses primer markdown styles, here's an example from another repo). I'll add this to the agenda for our sync today.

@shawnbot
Copy link
Contributor

shawnbot commented Sep 5, 2017

I'm down with moving this into /docs.

@broccolini
Copy link
Member Author

Closing this in favor of primer/primer.github.io#1

@broccolini broccolini closed this Sep 6, 2017
@shawnbot shawnbot deleted the temp_homepage branch October 17, 2018 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants