Responsive web site

[agdod]

 - the Git documentation (a.k.a. man/help pages, i.e. anything with a URL starting with https://git-scm.com/docs), which

Please make the site responsive to it scale nivel on tablet and phones. Reading the documentaion on iPad would ne lot nivel if it was responsive. Having just completed my web design responsive course i would be intrested on looking into this

[pedrorijo91]

hello @agdod.

There's a work in progress effort for this by @tarebyte on #1179

Thanks for showing availably to help!! tarebyte has been a bit busy, but maybe you could help him

[adsingh14]

Hi there! I would also like to contribute.

[peff]

@adsingh14 Thanks! I don't think anyone's actively working on this, and the site-refresh #1179 is pretty stale at this point. I think it would really need somebody to take ownership and just start working. Most of us who work on the site (and the Git project) don't have the skills / time / interest in the visual aspects, and so I consider it mostly to be in "maintenance" mode (i.e., we're just keeping it running and fixing bugs).

If it's something like making the site more responsive, I think that wouldn't be too hard to review (and a lot of it would just be evaluating the result).

For a bigger visual redesign, having it led by somebody who hasn't been involved with the site or the Git project previously may be a recipe for awkwardness. So if you (or anyone) is interested, I'd suggest prototyping a bit and then getting feedback from the greater community (people who watch this repo, but also folks on the Git mailing list). And then we can go from there.

[adsingh14]

@peff I'm interested to work as an individual. I have some queries to clarify,

1. Shall I make the current website responsive by updating CSS
   OR
   skip it to redesign all pages?

Regarding to redesign:

1. As a developer, I can handle both UI/UX and CSS of this static website. Is there any limitation for tools to be use ?
2. Should I create a new repo or create new branch for major UI/UX overhaul ?
3. I'll follow design-first approach for home-page. Where should I post prototype related updates ?

My focus is on CSS which won't affect the website functionality. Looking forward to your reply.

[jnavila]

Please read the README file to know how to feed and index the manpages and update the downloads. Everything is described in it.

[adsingh14]

Shall I upload responsive layout of current website ?

[jnavila]

Please open a pull-request with your changes.

[adsingh14]

@jnavila I'm going to use flex-box. Does it sounds good or I keep using float ?

[jnavila]

I'm sorry, I have strictly no idea what flex-box is and whether it should be better or not.

[adsingh14]

Okay, I won't explain in a nutshell but flexbox is supported by all browsers and take less space than float. I will submit first MVP.

[peff]

You probably need to run rake search_index to build the index (you'll want to make sure you've imported book and manpages (local_index, etc) so you have something to put in the search index.

[peff]

Unfortunately, I've reached to API rate limit.

Yes, you'll need to either set up a PAT for use with $GITHUB_API_TOKEN, or you'll need to just do a local clone and use local_index, etc. I suspect you could also limit the number of tags you're willing to import with REBUILD_DOC.
Ditto for the book local_genbook2, etc. I think there are examples of all of these variants in the README.

By the way, is there any way to check my PR before getting merge ?

We can spin up a review site via Heroku, but it doesn't happen automatically for cross-fork PRs. I've spun one up now (which will stay valid for a few days). You can see it at https://git-scm-pr-1641.herokuapp.com/ (it should also be linked from your PR's page).

[jnavila]

You need first to clone progit2 repo besides git-scm.com repo.

$ cd ..
$ git clone [email protected]:progit/progit2.git
$ cd git-scm.com

[peff]

Hmm. I suspect you need to actually have elasticsearch installed (and maybe point BONSAI_URL to it in the environment to give the right credentials). IIRC this is a minor pain, and it's probably been several years since I've actually done it in a dev environment.

[rimrul]

Looks like your bin/rake has CRLF line endings instead of LF line endings.

[adsingh14]

@peff I think this issue has been resolved.

#1421 (comment)

Ping me whenever major redesign will going to happen.