fakeiteasy/fakeiteasy.github.io

FakeItEasy's website

Code for FakeItEasy's website

fakeiteasy.github.io's Issues

Switch official chat solution to Gitter

Per FakeItEasy/FakeItEasy#535 (comment).
Sorry, Jabbr.

remove text and links from CodeBetter CI banner

According to the Server Itself,

a simple link to the image should be fine with this update, no need for the complex html from before

Add 404.html for better "what page?" experience

The current page is super bland. It might be nice to direct users to

1. the home page
2. the FakeItEasy docs (once we host them here)
3. the FakeItEasy.Analyzers docs (once we host them here)

I'm not an expert, but it might be possible to examine the incoming URL and guess which one is the best option, or maybe see if we can default to the best version of one of the docses?

Point to the twitter account

Because we have one now! fakeiteasyfx

We should probably point to it, because it'd be a crime for people to miss out on the scintillating tweets.

have Read The Docs redirect here for all versions

Adopt sidecar

See https://sidecar.gitter.im/

Looks interesting. Thoughts?

Add HTML5 semantics

A quick test using https://github.com/adamralph/h5h shows that the site has no HTML5 semantics.

Use new logo and favicons

Spun off from #4. It's be nice to have something that's a little more scalable.

backfill all the FakeItEasy docs versions that we feel like, adding them to this repo

Host the generated FakeItEasy.Analyzers docs on the FakeItEasy website

Host the docs

Google Analytics 4 is replacing Universal Analytics, and we have UA in the readthedocs docs (not even our analytics; something injected by RTD). We're not sure how to update the older versions of the docs on RTD, and thought maybe it would be fun to host the docs ourselves.

@thomaslevesque and I have decided to give this a go. It'll involve changes to this repo, the main FakeItEasy repo, and FakeItEasy.Analyzers.

Here's a rough plan, as I see it:

• FakeItEasy/FakeItEasy.Analyzers#30
• #54
• FakeItEasy/FakeItEasy#1886
• FakeItEasy/FakeItEasy#1896
• #59
• #61
  • update analyzer references to go to the docs hosted here* [ ] update links from the analyzer docs to the main docs so they don't go to readthedocs anymore
• update the Documentation button in the repo to point to the new docs
• #63
• figure out how to automatically trigger docs generation so new FakeItEasy and FakeItEasy.Analyzers docs are added here, at least when we release new versions

Host the most recent version of the FakeItEasy docs on the FakeItEasy website

Change "Fakeiteasy" to "FakeItEasy" on the homepage

The library's called FakeItEasy pretty much everywhere except a few instances on the homepage. Let's fix that up.

Enforce HTTPS

Like GitHub says we can

Switch to jekyll 3.0

Per GitHub's announcement.

Update nokogiri to close security vulnerability

As reported at https://github.com/FakeItEasy/fakeiteasy.github.io/network/alert/Gemfile.lock/nokogiri/open

Known high severity security vulnerability detected in nokogiri < 1.10.4 defined in Gemfile.lock.
Gemfile.lock update suggested: nokogiri ~> 1.10.4.

While we're in the area, maybe just update everything.

Have "Documentation" point to ReadsTheDocs docs

… once FakeItEasy/FakeItEasy#626 has been closed.

update docs links to point to readthedocs.io

per https://blog.readthedocs.com/securing-subdomains/

add codebetter/jetbrains banner

Split from FakeItEasy/FakeItEasy#89, which read

In return for hosting our CI server, CodeBetter and JetBrains ask that
we include their banner on our
website. E.g. https://github.com/liteguard/liteguard#sponsors

This ultimately should go on the website, but I think we should
complete FakeItEasy/FakeItEasy#55 before
making any changes to the website.

In the meantime, we can add the banner to the readme as in the
LiteGuard example above.

Now that we have a fresh website, we can look into adding the banner. Leaving the old issue open until we do it, though.

improve fakeiteasy landing page

Now that the landing page is its own project and appears at http://fakeiteasy.github.io, maybe we should consider making some modifications. I don't mean to be overly critical of the existing page, and many of these are just "thinking out loud"s, but I think we can improve a new viewer's experience when they land on the page.

The current page has some philosophy, a link to the GitHub repo, as well as some great examples of using FakeItEasy. Maybe too many. I think it could be a little overwhelming. How do you feel about

1. trimming the amount of text on the page quite a bit - maybe keep the philosophy and a very simple example, but move most of the examples to a "getting started" or a "cheat sheet", possibly with the rest of the documentation.
2. more obvious and standardized links to
   • the NuGet package
   • the Repo
   • the documentation (currently the wiki)
   • the Jabbr room
3. removing the .zip and .tar.gz. links - the source is available at the repo, even as a .zip file
4. changing the style? I'm not sure if Patrik is attached to the current page style/layout, but I don't think it's particularly well-suited to the kinds of changes I'm suggesting - more open, cleaner pages, such as NSubstitute's, Nancy's, or xBehave's seem to be the wave of the present.
5. making a favicon or other small logo? I like the "two ladies who are almost swearing at each other", but it doesn't scale down that well
6. getting an actual domain instead of fakeiteasy.github.io? I know, that's money, but I'd be in for a year or two to start.

As usual, a lot of words and ideas. If there's any interest at all, we could easily split the issue into subtasks and address the ones we care about piecemeal. Or we could drop the whole thing.

Oh, I'd be okay taking any parts of this. Maybe not a new favicon/whatever. I'm not so good at that kind of thing. Or probably web page design, but I can always start by taking an existing template and probably not get something that's an affront to the eyes.