Skip to content

Conversation

@lukechi1219
Copy link
Contributor

@lukechi1219 lukechi1219 commented Nov 2, 2021

fix ../../img/installation.gif

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[X] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@shaharkazaz
Copy link
Collaborator

@lukechi1219 Seems like the gif on the installation docs page is working as expected.
What's the issue here?

@lukechi1219 lukechi1219 closed this Nov 2, 2021
@shaharkazaz shaharkazaz reopened this Nov 2, 2021
@shaharkazaz
Copy link
Collaborator

@lukechi1219 I think I had a cached version of the docs. Thanks.

@shaharkazaz shaharkazaz added the good first issue Good for newcomers label Nov 2, 2021
@shaharkazaz
Copy link
Collaborator

@lukechi1219 Can you please also fix the gif path of the scope-lib-extractor? and please commit your changes using the commit command and force push to this branch.

@lukechi1219
Copy link
Contributor Author

lukechi1219 commented Nov 2, 2021

@lukechi1219 I think I had a cached version of the docs. Thanks.

hi, sorry for bothering you with such a small issue... btw I think it's not about cache. It seems related to react handle base URL of the installation.gif image.

when I first go to URL https://ngneat.github.io/transloco/docs/config-options , then click "Getting Started > Installation"

the image show normally

but if I refresh the page at https://ngneat.github.io/transloco/docs/installation

the image is broken.

when I open this pull request , I didn't notice it's related to refresh page, just thought maybe the relative path is wrong.

@shaharkazaz
Copy link
Collaborator

@lukechi1219 That's why I saw it working for the first time, nice catch.
Would you like to look into it? might be related to docusaurus

@shaharkazaz shaharkazaz self-requested a review November 2, 2021 10:32
@lukechi1219
Copy link
Contributor Author

lukechi1219 commented Nov 2, 2021

@shaharkazaz Well, I'm not familiar with docusaurus, but I can look into it in my free time.

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('/img/docusaurus.png')} />

TODO: run build and check at my local machine

@lukechi1219
Copy link
Contributor Author

@shaharkazaz I've fixed the image path with @docusaurus/useBaseUrl . I run and check at my local machine and it looks good. The image will still show after I refresh the page.

@shaharkazaz
Copy link
Collaborator

@lukechi1219 Nice work! Would you please commit your changes using the commit command and force push to this branch?

@lukechi1219
Copy link
Contributor Author

@lukechi1219 Nice work! Would you please commit your changes using the commit command and force push to this branch?

Hi @shaharkazaz , sorry I'm not sure what you mean... it's the first time in my life issue a pull request...

@shaharkazaz
Copy link
Collaborator

@lukechi1219 no worries, I'll explain.
We are using a commit convention to automate the package versioning, and currently, your commit isn't matching that convention.

Here are the steps you need:

  • Do a soft reset to your changes.
  • Add the changes to git via git add
  • Run npm run commit.
  • Force push to remote.

The commit command will prompt a series of questions (you should choose 'docs' for type) that will build the formatted commit message for you, and once done, it will commit the changes.

Because you already have a remote branch with commits, you will need to force push your fresh commit to make it the new HEAD.

Alternatively, since these are minor changes, you can create a new branch, redo the changes, commit them via the command and open a new PR.

Hope this helps.

@lukechi1219
Copy link
Contributor Author

@shaharkazaz Thanks! Now I know "commit command" refers to "npm run commit". I will try it later tonight.

@lukechi1219
Copy link
Contributor Author

@shaharkazaz Thanks! Now I know "commit command" refers to "npm run commit". I will try it later tonight.

@shaharkazaz , I suggest adding this step "npm run commit" in CONTRIBUTING.md , but my English is not very fluent... so just leave it to you. lol

@shaharkazaz
Copy link
Collaborator

@lukechi1219 I'll need you to re-commit and skip the braking change question (just press Enter) since giving it a value is considered that this commit has a breaking change 🙂

image path should be handled by useBaseUrl()
@lukechi1219
Copy link
Contributor Author

New commit force pushed, please kindly review.

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

Labels

good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants