loopback-next icon indicating copy to clipboard operation
loopback-next copied to clipboard

docs: Update Documentation

Open sushantbasak opened this issue 2 years ago • 10 comments

This PR fixes Expired Links in Docs. Related #8273

Checklist

  • [ ] DCO (Developer Certificate of Origin) signed in all commits
  • [ ] npm test passes on your machine
  • [ ] New tests added or existing tests modified to cover all changes
  • [ ] Code conforms with the style guide
  • [ ] API Documentation in code was updated
  • [x] Documentation in /docs/site was updated
  • [ ] Affected artifact templates in packages/cli were updated
  • [ ] Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

sushantbasak avatar Feb 04 '22 10:02 sushantbasak

@sushantbasak, thanks for the PR. Could you please sign the DCO? I believe our commit message guidelines expects the commit message to begin with lower case, i.e.

docs: fix DataSource Documentation Link

instead of

docs: Fix DataSource Documentation Link

Otherwise the commit linter will give an error.

After those are taken care of, squash the commits, it should be good to go. Thanks.

dhmlau avatar Feb 07 '22 16:02 dhmlau

I have updated the changes that are requested.

sushantbasak avatar Feb 09 '22 19:02 sushantbasak

@sushantbasak, thanks for incorporating the feedback. I have one minor change (as suggested change). Also, could you please sign the DCO? Without signing DCO, we won't be able to land your PR. Thanks. You can sign it by running the following command:

git commit --amend -s

dhmlau avatar Feb 09 '22 23:02 dhmlau

@dhmlau For DCO do I need to run git commit --amend -s after creating commits?

sushantbasak avatar Feb 10 '22 04:02 sushantbasak

-s is for adding the DCO sign-off; Though the sign-off can be typed manually as well.

--amend is for modifying the previous commit (e.g. If you've forgotten to use -s for your last commit).

achrinza avatar Feb 10 '22 06:02 achrinza

I am not able to get why DCO is not working. Can anyone help?

sushantbasak avatar Feb 14 '22 12:02 sushantbasak

I think it's because you have 3 commits and 2 of them are signed. Could you please squash the commits, and check that the resulting one commit is signed?

dhmlau avatar Feb 14 '22 15:02 dhmlau

It looks like you have a merge commit (https://github.com/loopbackio/loopback-next/pull/8286/commits/cb324e6811e69b9a4788e19314e8aebe91a7963f), which may cause issues with the Git history when merging. To fix the issue, drop the merge commit (Sometimes a rebase would do this automatically) and squash the commits into one.

If preferred, the maintainers can try to push the changes onto this PR from our end.

achrinza avatar Feb 16 '22 14:02 achrinza

This is the git history image I am getting this when I am trying to rebase. image

Can you let me know what should I do after this? @dhmlau

sushantbasak avatar Feb 17 '22 12:02 sushantbasak

@sushantbasak, sorry that I missed your message. Since not all the commits in the PR are signed, that's why DCO bot complained. I'd suggest you rebase and squash all the commits into one. This section of the docs might help: https://loopback.io/doc/en/lb4/submitting_a_pr.html#9-final-rebase-and-squashing-of-commits.

If it doesn't work, like @achrinza said, we can help you to squash it, as long as you grant us permission to push.

dhmlau avatar Mar 25 '22 19:03 dhmlau

Closing as abandon. @sushantbasak, if you decide to continue with this PR, please sign your commits with DCO. Thanks.

dhmlau avatar Feb 03 '23 14:02 dhmlau