jigsaw-docs-template icon indicating copy to clipboard operation
jigsaw-docs-template copied to clipboard

Prototype of merging 'blog' -> 'docs'

Open cameronelliott opened this issue 5 years ago • 12 comments

[edited:fixed bad netlify links]

Hi guys, here is a prototype of my work merging 'blog' into 'docs'. Ideally start viewing on 'large (lg)' display, cause I need help on top-nav on sm/md. I know you guys are busy, so here is a build:

http://172.92.141.143/ There is one blog page I didn't integrate into the navigation: blog orphan

So, I have two questions for you guys:

  1. Do you think you guys might/maybe be interested in having this become a Tighten template? It may be less work than maintaining two templates, also, it could (with-work) possibly be configurable for: blog+docs, docs-only, blog-only. I totally understand it may not work for your needs, if that is the case, we don't have to work through the PR and you guys don't have to review it, etc, etc... If you think: maybe, possibly, it might be interesting for us, then let me know any PR changes you would like to see...

  2. There is one thing I would humbly like to ask for suggestions, or even a little coding help with if you feel generous. :smile: (please say no if too busy) My ask: right now the top-nav ("Blog About Contact") only shows up on lg:+, and disappears on sm,md,etc... I tried to merge the techniques used for small-responsive top-nav used in 'blog' into 'docs', but I didn't like how the top-nav elements (blog,about,contact) blend-into the docs-nav elements on 'docs' pages when I tried doing so.

I would like to see if you guys can suggest what flex/tailwind classes are needed for the divs containing the top-nav elements, so that it will grow from a single-row (current) to two-rows, or maybe even more than two-rows as the view port contracts. I may take a stab at this, but I am learning tailwind/flexbox in the process.

Thanks to @mattstauffer for his promptness, patience and advice, thanks @anthonyterrell for merging the upgrade and reviewing, and thanks to all of you for creating and maintaining these wonderful works. :tada: :taco: @damiani

cameronelliott avatar Aug 22 '19 07:08 cameronelliott

PS, Algolia is broken but forced to show on purpose for the reason of showing you the search box in your review. It can be fixed by replacing the invalid Algolia creds currently in place.

cameronelliott avatar Aug 22 '19 07:08 cameronelliott

PPS the written copy for readme and other articles in this repo will need someone's (mine?) review and fixing if this template is to get up to git-sharable / publishable condition. But I wanted to share the code prototype and get feedback before investing time in that. I suppose the Jigsaw written copy would need work also. I suppose a lot depends on whether you think this is an alternative to the current blog/docs (as an offering from the Tighten repo) You may want to look at Docusaurus to see how another docs package uses a blog+documentation. Docusaurus
(simply to see another view on things)

cameronelliott avatar Aug 22 '19 07:08 cameronelliott

I fixed the broken Netlify links. I just hope I am not creating too much work for you guys, I know how much work even reviewing a PR can be. Please let me know what works best for you guys, even if you are too busy to deal with this. Much thanks in advance, Cameron.

cameronelliott avatar Aug 23 '19 03:08 cameronelliott

Hey you guys, I put this up here, not as a full "here it is, please merge", but as "Hi guys, here is a prototype, what do you think?" as I said at first.

I posted this to generate a conversation to see if it is of any interest to the Tighten team, that is all.

Any feedback, good, bad, indifferent, "go-away-please" is totally appreciated.

I am sure you guys are very busy, so I understand this is not a priority, honestly, I am trying to do too many other things, so I really probably don't actually have much time to get this super clean and tight either....

But mostly I wanted to see if you guys had any thoughts about the value of a single merged docs/blog template.

Well, I am sorry to bother you guys again, but I was surprised nobody had any thoughts. Nonetheless, thanks all of you for your great open source contributions.

cameronelliott avatar Aug 30 '19 05:08 cameronelliott

I mentioned this in an email, but we're very interested, just very busy, and the bigger the PR is, the longer we have to set aside to review it. Thanks for your hard work!

mattstauffer avatar Aug 30 '19 12:08 mattstauffer

@cameron-elliott I'm going to take a look at this today ... my instinct is to treat this as a separate third template, but let me think through it and get back to you. Thanks for working so hard on this! 👍

damiani avatar Aug 30 '19 12:08 damiani

@damiani FWIW, that's 100% my instinct as well.

mattstauffer avatar Aug 30 '19 12:08 mattstauffer

Hey guys, I feel bad for pinging you now, sorry, I really just wondered if I had committed a faux pas and said something wrong. Please take all the time in the world.... Anyway, really love your guys stuff. Thanks for making it.

cameronelliott avatar Aug 30 '19 17:08 cameronelliott

FYI @cameron-elliott It's been a full month--this is almost at the top of my todo list as of yesterday. Thanks for your work--I saw you push up a commit, so you're thinking about it, too. Hopefully this week!

mattstauffer avatar Oct 01 '19 01:10 mattstauffer

No worries, it's all good, I understand you all probably have 1e6 other things to be looking at also. I do! I didn't really intend for that article to go into the PR, so I need to see how to fix that. Lol.

cameronelliott avatar Oct 01 '19 01:10 cameronelliott

@cameron-elliott I've set up a new repo that we can use to make this a new, third combined template, separate from blog and docs ones, so we can keep those simple. Can you PR your code over there, and then we can continue discussing/modifying in that repo?

https://github.com/tightenco/jigsaw-combined-template

damiani avatar Oct 11 '19 17:10 damiani

I tried cloning the repo and just changing the origin primary remote, which was probably a little optimistic.

image

Any suggestions on how to move those commits of mine over in the simplest way from here: https://github.com/cameron-elliott/jigsaw-docs-blog-template-master to here: https://github.com/cameron-elliott/jigsaw-combined-template

I could just use a diff tool to edit all the commits back into a clean 'combined' checkout, but then I would need to re-commit each commit or commit it as a big single poor-named commit.

Ideas?

cameronelliott avatar Oct 15 '19 01:10 cameronelliott