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

Grammar and other changes #33

Open
wants to merge 38 commits into
base: master
Choose a base branch
from

Conversation

thecodingdoc1
Copy link
Contributor

There were a few TODOs that were in the wiki that were visible to the public. I deleted these for better readability.

There are also links that are not pointing anywhere, are broken, or are not pointing to a page that makes sense with the context the link is in.

If there are any changes or clarifications that are needed, please feel free to ask.

The links at the bottom of the page are not working. From Information for Developers down to but not including the See also section.
Same issue with this page as well. None of the links are working. After checking multiple other pages, none of the external links were working for me. I am unsure if it is my computer and connection or the wiki. All of the links that correspond to other pages on the wiki are working fine.
Built in roles is still a TODO item and link is not functional. Once fixed, you can delete the (link not completed)
There are two TODOs that are in this page. I have deleted them for readability. Did not know if you wanted to have a task for these two sections instead of leaving the TODO visable to the general public?
the use of or not is not gramatically needed. It is personal judgement if it should be included.
Chenged some grammer but also removed the TODO  item from the Wiki.

In the directory-structure.md file, I attempted to correct the broken links
Tried again to correct the storage link based on the same link on a different page
Small grammer corrections
@carlspring carlspring changed the title Grammer and other changes Grammar and other changes Jun 6, 2019
Copy link
Contributor Author

@thecodingdoc1 thecodingdoc1 left a comment

Choose a reason for hiding this comment

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

I corrected the changes that you noted. I apologize for the minor mistakes.

@carlspring
Copy link
Member

carlspring commented Jun 10, 2019

Don't worry! Could you just make sure you've reverted all the systemd references?

Let me know when you're done and I'll merge your changes!

Thanks for polishing this up! :)

This should have corrected the systemd instances back to systemd where appropriate. Please let me know if there are any that I missed.
Copy link
Member

@steve-todorov steve-todorov left a comment

Choose a reason for hiding this comment

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

Thanks for finding and fixing all of these grammar issues and typos! However, there are a few little things which should be addressed before we can merge this (and if there are no more comments from @carlspring). Could you please have a look when you have time? Thanks in advance!

docs/developer-guide/building-the-code-with-docker.md Outdated Show resolved Hide resolved
docs/developer-guide/ide-setup/eclipse.md Outdated Show resolved Hide resolved
docs/developer-guide/project-structure.md Show resolved Hide resolved
docs/user-guide/artifact-query-language.md Outdated Show resolved Hide resolved
docs/user-guide/directory-structure.md Outdated Show resolved Hide resolved
docs/user-guide/directory-structure.md Outdated Show resolved Hide resolved
docs/user-guide/ui/user-management.md Show resolved Hide resolved
thecodingdoc1 and others added 15 commits June 17, 2019 15:02
The use of a comma is needed because there is a list of items. Starting with [docker/compose#3328][issue-3328]. It includes this issue, issue 4700, and finally issue 1318. There should be a comma before the and in a list.

Co-Authored-By: Steve Todorov <[email protected]>
Corrected links to point to correct location
Should correct all comments made including readding the TODOs
comma breaks up the flow of the sentence
The http://127.0.0.1:2480/studio/index.html link does not work. I am assuming because the link would become active once the OrientDB has been installed and configured. Should we maybe state (this link will not work until OrientDB has been installed and configured). I am not familiar with Orient and do not know if this location might vary depending on the develoeprs system.

In the Creating a DAO layer, I changed the semicolons for periods as each line was a complete sentence.
for EventListener link, the link showed 404 because there is no file in that directory named EventListener. I was unsure which specific EventListener was intended so I linked it to the event directory. As such, I cannot find the code snippet that is displayer referencing the method in EventListener.
The logging.md file that I have in my system is the one that I corrected. I noticed just before sending this that the file name that is in the repo was add-logging.md. Please let me know if the changes to this file look good. If they do, I can update the add-logging.md file seperately in a different commit.
lines 86-89 are not formated properly. In the code, it is formated to have a new line for each of the points but in the wiki it does not express that new line and instead just runs them all together. I do not know enough about markup to adjust this. If anyone knows how, please let me know and I will correct it in a new commit. Thank you.
@carlspring
Copy link
Member

Apologies for the late response! What's the status of this pull request?

@thecodingdoc1
Copy link
Contributor Author

thecodingdoc1 commented Aug 14, 2019 via email

@steve-todorov
Copy link
Member

Hi @thecodingdoc1,

Apologize for the late reply - somehow I missed your messages.
I will rebase this branch and resolve the conflicts for you.

Do you have any other pages you haven't gone through yet or should I merge the PR after I rebase it?

// cc @carlspring ICLA ?

@thecodingdoc1
Copy link
Contributor Author

There should be no other pages. I have been working on other things and have not been able to get to the rest of the wiki. I will start back up shortly

@ghost
Copy link

ghost commented Oct 2, 2019

DeepCode Report (#bc9ac5)

DeepCode analyzed this pull request.
There are no new issues.

@thecodingdoc1
Copy link
Contributor Author

I am unsure what is going on.

@thecodingdoc1
Copy link
Contributor Author

I know that I had to update my local repo with the changes that have occured on the master. That might be the issue.

@carlspring
Copy link
Member

@thecodingdoc1 ,

Could you please rebase this, so that we could re-review it and consider merging it? Thanks! :)

@thecodingdoc1
Copy link
Contributor Author

@carlspring, to be honest I have never rebased and do not fully understand how to do it. I do not know the how to rebase a previous commit.

@thecodingdoc1
Copy link
Contributor Author

When attempting to rebase, I am getting a conflict with every file that I am trying to rebase. I know that my branch is 38 commits ahead but 68 commits behind the master. I am trying to figure out if it would be best for me to fork off a new branch and make the necessary changes to that branch. I think there were some things that I might have messed up as I was first learning Git and programming in general when I started contributing.

@steve-todorov
Copy link
Member

Hi @thecodingdoc1,

Since you have updated this branch using merge quite a few times instead of rebasing it has introduced a some noise. If you're up for it - we can close this PR and start fresh. However, please have a look at our Developer Guide so you understand how to rebase as it is important to keep things in sync. :)

@thecodingdoc1
Copy link
Contributor Author

That is fine. I apologize for the situation. I will read the developer guide so that this does not happen again.

@steve-todorov
Copy link
Member

No problem! Ping me in the chat if you need help :)

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