Skip to content
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

Move documentation files in the docs folder #347

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

Ayushi271
Copy link

Description

Fixes # [ISSUE]

Type of Change:

  • Code
  • Quality Assurance
  • User Interface
  • Outreach
  • Documentation

Code/Quality Assurance Only

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update (software upgrade on readme file)
  • New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials
  • I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have attached link of deployed site.
  • Any dependent changes have been merged

Code/Quality Assurance Only

  • My changes generate no new warnings
  • My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been published in downstream modules

As I have made some previous commits but have to delete them that's why I already have moved the files to the doc folder but some links were broken so I fix it in this now it's working fine.

@@ -5,7 +5,7 @@ _**Note**: This is only needed if you want to contribute to the project._
If you want to contribute to the project you will have to create your own copy of the project on GitHub. You can do this by clicking the
**Fork** button that can be found on the top right corner of the [landing page]([https://github.com/anitab-org/anitab-org.github.io]) of the repository.

## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#clone)Clone
## [](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Fork,-Clone-&-Remote#clone)Clone
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## [](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Fork,-Clone-&-Remote#clone)Clone
## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#clone)Clone

No need for this change, if you are keeping the link of the Wiki :)

@@ -19,7 +19,7 @@ where `YOUR_GITHUB_USER_NAME` is your GitHub handle.

`git clone https://github.com/anitab-org/anitab-org.github.io`

## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#remote)Remote
## [](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Fork,-Clone-&-Remote#remote)Remote
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## [](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Fork,-Clone-&-Remote#remote)Remote
## [](https://github.com/anitab-org/anitab-org.github.io/wiki/Fork,-Clone-&-Remote#remote)Remote

Removing for same reason as above ;)

@@ -7,7 +7,7 @@
- When developing a new feature, include at least one test when applicable.
- When submitting a PR, please follow [this template](PULL_REQUEST_TEMPLATE.md) (which will probably be already filled up once you create the PR).
- When submitting a PR with changes to user interface (e.g.: new screen, ...), please add screenshots to the PR description.
- When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR.
- When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/docs/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR.
- When submitting a PR, please follow [testing guidelines](https://github.com/anitab-org/anitab-org.github.io/wiki/Prepare-testing-GitHub-Pages-for-your-PR), copy the link and place it in your PR.

No need to add "docs" to the path, as this is an actual Wiki page. So it does not refer to the wiki file on the repository :)

Copy link
Member

@isabelcosta isabelcosta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing @Ayushi271 !

Just a few comments:

  • The placing of the files seems to be correct :)
  • The changes in package-lock.json are unnecessary so can you please revert the changes to that file? Because these are not related to the issue you're trying to solve
  • The changes on files under .github folder don't need the changes, since even though the file being moved is called Wiki.md this is not being used for the links you've changed - which are pointing to Wiki page of the repository on GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants