#552 Help with the Fedora Project overview documenation visual design
Closed: Fixed a month ago by mattdm. Opened 2 years ago by mattdm.

We have new overview documentation for Fedora replacing some aged wiki pages.

You can see this in staging live on the docs site and in asciidoc source.

I pulled in some graphics from the wiki, but there's a lot of room for improvement. Can you help?

I'm mostly looking for graphical flourishes, but layout and whatever else is on the table as well — although note that improvement to the overall look of the docs site (including styles, fonts, etc.) are out of scope and a separate design project. (And for that matter, any improvements should have the possibility of the style changing in mind.)

I can either work with mockups and convert to asciidoc, or you can make asciidoc changes directly if you prefer — whatever works! (FWIW, asciidoc quick references here).

I'm mostly concerned with the stuff in the "Project" folder basically everything in the repo could stand improvement.

Thanks!


Incomplete, but some ideas here

bitmap.png

That is lovely! Awesome!

The top header is the docs site header; I think that has to be the same or at least consistent across the site, so "Fedora Project Community" can't go there.

On the Mission & Foundation pages, I like the "Community" graphic, but I think it needs to be Project & Community.

if we can have a unique id per doc / book in the html (ideally html tag) the common top header is nukeable and replaceable.

i wanted a very very large community on the page to emphasize this is not getfedora.org nor is it meant to be.

why cant we illustrate the concept of community exclusive of "project"? its not meant to be a headline but an ilustration... i can dial back the contrast on the community text to make it seem less like a headline?

We can nuke the common top header, but I don't understand why we should. This is the site for Fedora documentation, including community and project documentation.

why cant we illustrate the concept of community exclusive of "project"? its not meant to be a headline but an ilustration... i can dial back the contrast on the community text to make it seem less like a headline?

Ah, I see. At the top of the page like that, it seems to apply to the whole document, and since this page also serves as the intro to the whole "Project Overview" section, possibly to the other documents in this section as well. You're saying you meant it to "attach" to that first What is Fedora? paragraph?

Oh, also, because of how the software works, the primary headline (in this case, "Fedora’s Mission and Foundations") needs to be at the very top; we'd need to do some crazy CSS to stick a graphic above that. But maybe that's okay anyway.

OK, so this sub-section of a broader docs site has a subsection that fedoraproject.org should be pointed to, but the design aimed for viewing at fedoraproject.org should not impede the broaders docs.fedoraproject.org site nor the subsections of the project documentation?

Can we just stand up a static page with a dump of the specific sub sub section (we could probably employ an iframe to keep the content update) and have a site specifically designed for fedoraproject.org that could serve that purpose without disturbing the universe here?

right now it seems like the different purposes are at odds...

Can we just stand up a static page with a dump of the specific sub sub section (we could probably employ an iframe to keep the content update) and have a site specifically designed for fedoraproject.org that could serve that purpose without disturbing the universe here?

Yeah, that might be a better idea for the fedoraproject.org redirect suggestion. In fact, I think that's part of the whole reason for this new asciidoc thing; we should be able to regenerate that page in a different format for different use pretty trivially. I'll talk to @bex.

But, this request is at least partially independent of that — I'd like the pages on the docs site to look nicer.

@mattdm that should be a separate ticket for @ryanlerch to fedora-bootstrapify the new docs site.

@mattdm that should be a separate ticket for @ryanlerch to fedora-bootstrapify the new docs site.

Yes, I know @bex is talking to @ryanlerch about that. That's what I meant by "although note that improvement to the overall look of the docs site (including styles, fonts, etc.) are out of scope and a separate design project" up above.

But most of the stuff on your mockup — new graphics, column layout, etc.... that's what I'm looking for here.

@mattdm okay, i've been looking at it from the context of having an fpo landing page (i came here from mktg ticket #756), so that context has been heavily coloring my viewpoint here -

who is the intended audience of this document? i want to better understand that before coming up with a full suite of styles / graphics for the full doc.

(Also are you expecting them to land on it by starting at docs.fpo or are they going to visit direct from somewhere else?)

By nature, the audience is somewhat broad; it's anyone who wants to know more about the project (as opposed to just getting the software or getting help with the software). This would include:

  • As a potential user of Fedora software, I want to know about the people who make the software, and their values and approaches, so I can judge if these align with things I care about.
  • As a potential user of Fedora, I want to know what Fedora is working on in the near future, and what makes Fedora interesting and special, so I know if Fedora's future offerings are likely to be right for my needs
  • As a current user of Fedora, I want to know who is making decisions (and why decisions are made in the way they are), so I can understand why things are the way they are and potentially influence them better suit my needs.
  • As a current Fedora user, I want to talk to someone about something, for help or to give feedback: how can I find the right person, so I can communicate effectively?
  • As a potential Fedora contributor, I want to know what the project structure is, how volunteering for the project works, and where I can plug in, so I can contribute meaningfully and quickly.
  • As a user or contributor advocate for Fedora, I want a quick, accessible summary of the "Fedora story" which I can learn and repeat and which I can share with others, so that I know I'm telling the official story.
  • As a contributor making a strategic decision, I want to consult with official project strategy documents so that I know the choices I make are aligned with the project's official goals.

I expect people to get here via four paths:

  1. Searching for something Fedora-related that lands them there directly.
  2. Going to fedoraproject.org from a link (e.g. wikipedia)
  3. From browsing docs.fpo
  4. By clicking on "About Fedora" on getfedora.org (or other project sites).

@duffy Is that helpful? Anything more I can do to clarify?

I'd love the graphics / assets from your mockup — that's a big improvement from what I've got. Any objection to starting with that (leaving off the "community" banner for now)?

@mattdm it is helpful; i do hate to be a nag but do you have any flock '17 pics you can send me that i could use as well? you can of course use anything here now but i do intend to finish :-) and modify based on audience.

(ed. this was orig an email comment and it wasn't parsed well, cleaned it up manually)

@mattdm here's a set of graphics you can use in the docs as-is.... should we do a separate ticket for designing the second output of the file into a static site for fedoraproject.org using the same content?

Yeah, a second ticket is a good idea.

Metadata Update from @duffy:
- Issue assigned to duffy

2 years ago

Okay, initial improvements at https://docs.fedoraproject.org/fedora-project/project/fedora-overview.html.

Note that a few changes from https://pagure.io/fedora-docs/docs-fp-o/issue/43 to the global CSS will fix the top "get fedora" box to better match the mockup.

OK so in terms of this ticket, where are we at now? You want more visual design for the entirety of the doc, right? Does that have to wait on static site generation? @mattdm

I'm pretty happy with how this came out as https://docs.fedoraproject.org/fedora-project/project/fedora-overview.html for right now. It's missing the top banner graphic and if you've got some ideas for that we could iterate, or if not we can just close this.

There's a minor problem with the background shading of the cells I had to resort to to get two-column layout in asciidoc, but we have a planned fix for that.

Oh, it's also missing the graphic for "features", but that's just an oversight.

And the plan for a new fedoraproject.org mini-front-page-site based on this content is at https://pagure.io/fedora-websites/issue/756 and can be tracked separately.

Metadata Update from @duffy:
- Issue tagged with: triaged

2 years ago

Yes. Thanks for this!

Metadata Update from @duffy:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

2 years ago

Hi @mattdm - I'm re-opening this - Grace worked on a new version of this with some tweaks including nicer typography design:

overview-gcolbert.png

(Source SVG):
Fedora_MissionsFoundations_MockNEW.svg

Are you open to some updates? Also, would you like the other sections of the site to have a designer create some mockups / designs for them?

Metadata Update from @duffy:
- Issue assigned to gcolbert (was: duffy)
- Issue status updated to: Open (was: Closed)

a year ago

Nice! Yes, I'm open to updates.
This will be easier to shoehorn into asciidoc than the previous 2-column design. @ryanlerch, can you reconcile this with the style?

I'd like help with other sections too, but I want to hold off a little bit in waiting for Ryan's style refresh to land.

@gcolbert I have a little bit of concern with the pull quote formatting, since normally pull quotes are duplicated in the text, and this is not that. (Arguably, I should not have used that style for the mission statement in the current version). There is a "lead" class we could use....

@mattdm That makes total sense in regards to the pull quotes. I can do a new mockup with the section summaries distinguished from body text in some other way than the current pull quote treatment. What does the "lead" class look like? My only concern is that I think these blocks of text should really be heavily distinguished from the body text to break up the reading a bit--maybe with some element of color as well as a typesetting switch.

@gcolbert Right now the lead class uses a slightly larger font and a slightly lighter weight. However, really, it can look however @ryanlerch thinks it should for the overall site design. :)

It might not be the right class for this use, though — there's another page where I wanted a "highlight this paragraph to break up this reading with an element of color or something" style, and maybe Ryan can add a class for that or tell us an existing bootstrap class or something.

NEEDINFO @ryanlerch :)

@mattdm The latter option (new/existing bootstrap class with color/some other stylistic addition) sounds perfect--once Ryan gets that info I will update my mockup to reflect that class.

@mattdm this is done right? should I keep this open or close?

It's done. We maybe could do a refresh at some point, though? Some of this didn't perfectly survive the transition to Antora. (See https://docs.fedoraproject.org/en-US/project/). But not urgent.

Metadata Update from @mattdm:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

a month ago

Login to comment on this ticket.

Metadata
Attachments 5
Attached 2 years ago View Comment
Attached 2 years ago View Comment
Attached 2 years ago View Comment
Attached a year ago View Comment