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

Emphasize file names #5608

Closed
shannonbux opened this Issue May 30, 2018 · 16 comments

Comments

Projects
None yet
5 participants
@shannonbux
Collaborator

shannonbux commented May 30, 2018

Before people copy and past code, make sure they know WHERE to paste it by emphasizing the file names. People often miss the name of the file or directory where the code is supposed to go.

@shannonbux shannonbux created this issue from a note in Documentation Project (To do) May 30, 2018

@shannonbux shannonbux changed the title from Tutorial edit: Before people copy and past code, make sure they know WHERE to paste it. People often miss the name of the file or directory where the code is supposed to go. to Emphasize file names May 30, 2018

@tulikavijay

This comment has been minimized.

Show comment
Hide comment
@tulikavijay

tulikavijay Jun 5, 2018

Contributor

I want to work on this ...where should i start??

Contributor

tulikavijay commented Jun 5, 2018

I want to work on this ...where should i start??

@Aloysb

This comment has been minimized.

Show comment
Hide comment
@Aloysb

Aloysb Jun 28, 2018

Hi!

I will work on this now if still available.

Cheers

Aloysb commented Jun 28, 2018

Hi!

I will work on this now if still available.

Cheers

@shannonbux

This comment has been minimized.

Show comment
Hide comment
@shannonbux

shannonbux Jun 28, 2018

Collaborator

Oh man, @tulikavijay and @Aloysb I apologize for the late response! Yes, this is still available. It would be useful to make the name of each file where people are supposed to paste their code more emphasized (probably a level 4 header, or at least bold or something). I've noticed that people often paste their code into the wrong place! I'm open to other ideas of how to solve this problem, too!

Collaborator

shannonbux commented Jun 28, 2018

Oh man, @tulikavijay and @Aloysb I apologize for the late response! Yes, this is still available. It would be useful to make the name of each file where people are supposed to paste their code more emphasized (probably a level 4 header, or at least bold or something). I've noticed that people often paste their code into the wrong place! I'm open to other ideas of how to solve this problem, too!

@Aloysb

This comment has been minimized.

Show comment
Hide comment
@Aloysb

Aloysb Jun 28, 2018

No worries! I'll have a go at it.

Aloysb commented Jun 28, 2018

No worries! I'll have a go at it.

@shannonbux

This comment has been minimized.

Show comment
Hide comment
@shannonbux

shannonbux Jun 28, 2018

Collaborator

Sounds great @Aloysb! Why don't you try it with just one page of the tutorial to test out the idea and see if the community likes it before editing all the pages. Thanks for volunteering for this!

Collaborator

shannonbux commented Jun 28, 2018

Sounds great @Aloysb! Why don't you try it with just one page of the tutorial to test out the idea and see if the community likes it before editing all the pages. Thanks for volunteering for this!

@Aloysb

This comment has been minimized.

Show comment
Hide comment
@Aloysb

Aloysb Jun 28, 2018

@shannonbux Ok, I tried to do a PR on this issue but I don't know if I am doing this right (I am new to this). Help would be welcomed! :)

I tried to do the PR to the V1 branch as asked for modifications to docs, but I had 700+ commits, mostly other people's work... So I thought something is wrong! To "master", only my changes appeared, so I did the PR to Master. I hope I am not creating a mess here!

There it is:
#6220

Thanks.

Aloysb commented Jun 28, 2018

@shannonbux Ok, I tried to do a PR on this issue but I don't know if I am doing this right (I am new to this). Help would be welcomed! :)

I tried to do the PR to the V1 branch as asked for modifications to docs, but I had 700+ commits, mostly other people's work... So I thought something is wrong! To "master", only my changes appeared, so I did the PR to Master. I hope I am not creating a mess here!

There it is:
#6220

Thanks.

@shannonbux

This comment has been minimized.

Show comment
Hide comment
@shannonbux

shannonbux Jun 29, 2018

Collaborator

Hi @Aloysb yes, it is a bit confusing right now because we have v1 and master versions of the docs! Apologies for the difficulty that creates. I did the exact same thing the other day: I wrote a blogpost and when I tried to merge it into v1, I also had 700+ conflicts with the v1 branch because I had already updated my local version of Gatsby to master. So I just merged the PR to master and then @m-allanson "cherry picked" or just copied the blogpost over to v1 so that it could reside in both branches. Hopefully this will get less confusing pretty soon :)

Collaborator

shannonbux commented Jun 29, 2018

Hi @Aloysb yes, it is a bit confusing right now because we have v1 and master versions of the docs! Apologies for the difficulty that creates. I did the exact same thing the other day: I wrote a blogpost and when I tried to merge it into v1, I also had 700+ conflicts with the v1 branch because I had already updated my local version of Gatsby to master. So I just merged the PR to master and then @m-allanson "cherry picked" or just copied the blogpost over to v1 so that it could reside in both branches. Hopefully this will get less confusing pretty soon :)

@shannonbux shannonbux moved this from To do to In progress in Documentation Project Jul 3, 2018

@shannonbux shannonbux added this to To Do - v2 in Gatsby v2 Release via automation Jul 20, 2018

@shannonbux shannonbux moved this from To Do - v2 to non-blocking but would be great to have in Gatsby v2 Release Jul 20, 2018

@shannonbux shannonbux removed this from In progress in Documentation Project Aug 31, 2018

@shannonbux shannonbux removed this from non-blocking but would be great to have in Gatsby v2 Release Aug 31, 2018

@shannonbux

This comment has been minimized.

Show comment
Hide comment
@shannonbux

shannonbux Sep 4, 2018

Collaborator

Saving this image @Aloysb--thanks! If anyone wants to pick up the work left over from #6220, that would be great!

image

Collaborator

shannonbux commented Sep 4, 2018

Saving this image @Aloysb--thanks! If anyone wants to pick up the work left over from #6220, that would be great!

image

@DSchau

This comment has been minimized.

Show comment
Hide comment
@DSchau

DSchau Sep 4, 2018

Contributor

@shannonbux I think I can take this. I even wrote something a while ago to do just this :)

The plugin | Example

Contributor

DSchau commented Sep 4, 2018

@shannonbux I think I can take this. I even wrote something a while ago to do just this :)

The plugin | Example

@shannonbux

This comment has been minimized.

Show comment
Hide comment
@shannonbux

shannonbux Sep 4, 2018

Collaborator

Wow awesome @DSchau--that'd be great!

This + a copy/paste button would resolve about 80% of problems we saw happen in our first Gatsby workshop back in April :)

Collaborator

shannonbux commented Sep 4, 2018

Wow awesome @DSchau--that'd be great!

This + a copy/paste button would resolve about 80% of problems we saw happen in our first Gatsby workshop back in April :)

@kakadiadarpan

This comment has been minimized.

Show comment
Hide comment
@kakadiadarpan

kakadiadarpan Sep 20, 2018

Contributor

@shannonbux @DSchau is this issue fixed?

Contributor

kakadiadarpan commented Sep 20, 2018

@shannonbux @DSchau is this issue fixed?

@DSchau

This comment has been minimized.

Show comment
Hide comment
@DSchau

DSchau Sep 20, 2018

Contributor

@kakadiadarpan thanks for circling back!

It is done but I'd still like to do the copy snippet at some point. That said, the actual issue itself we should call done, so I'll close!

Contributor

DSchau commented Sep 20, 2018

@kakadiadarpan thanks for circling back!

It is done but I'd still like to do the copy snippet at some point. That said, the actual issue itself we should call done, so I'll close!

@DSchau DSchau closed this Sep 20, 2018

@DSchau

This comment has been minimized.

Show comment
Hide comment
@DSchau

DSchau Sep 20, 2018

Contributor

Note: we should also open another issue to actually use the functionality (i.e. add it to tutorials and blog posts!) so we can get some community members involved!

Contributor

DSchau commented Sep 20, 2018

Note: we should also open another issue to actually use the functionality (i.e. add it to tutorials and blog posts!) so we can get some community members involved!

@kakadiadarpan

This comment has been minimized.

Show comment
Hide comment
@kakadiadarpan

kakadiadarpan Sep 20, 2018

Contributor

@DSchau we already have another issue open for copy snippet functionality #5030

Contributor

kakadiadarpan commented Sep 20, 2018

@DSchau we already have another issue open for copy snippet functionality #5030

@DSchau

This comment has been minimized.

Show comment
Hide comment
@DSchau

DSchau Sep 20, 2018

Contributor

@kakadiadarpan I meant an issue for people to actually tie into the title functionality. Basically I've implemented the functionality so that it's available, but very few tutorials/posts are actually using it currently!

Contributor

DSchau commented Sep 20, 2018

@kakadiadarpan I meant an issue for people to actually tie into the title functionality. Basically I've implemented the functionality so that it's available, but very few tutorials/posts are actually using it currently!

@kakadiadarpan

This comment has been minimized.

Show comment
Hide comment
@kakadiadarpan

kakadiadarpan Sep 20, 2018

Contributor

Got it, thanks for the clarification! 😄

Contributor

kakadiadarpan commented Sep 20, 2018

Got it, thanks for the clarification! 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment