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.

Sign up for GitHub

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

Jump to bottom

✨ New Documentation (No large files!) ✨ #911

Merged
merged 35 commits into from
Dec 14, 2023
Merged

✨ New Documentation (No large files!) ✨ #911

merged 35 commits into from
Dec 14, 2023

Conversation

AdrianaCeric
Copy link
Contributor

Checklist

  • Appropriate branch selected (all PRs must first be merged to dev before they can be merged to master)
  • Any modified or new methods or classes have helpful JSDoc and code is thoroughly commented
  • The description lists all applicable issues this PR seeks to resolve
  • The description lists any configuration setting(s) that differ from the default settings
  • All tests and CI builds passing
  • The description lists all relevant PRs included in this release (remove this if not merging to master)
  • e2e tests are all passing (remove this if not merging to master)

Description

@AdrianaCeric
Copy link
Contributor Author

Part 2 of getting this documentation done!

@AdrianaCeric AdrianaCeric marked this pull request as ready for review September 18, 2023 20:16
philip-cline
philip-cline suggested changes Nov 24, 2023
View reviewed changes
Copy link
Contributor

@philip-cline philip-cline left a comment

Choose a reason for hiding this comment

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

Couple of changes. Thanks again for all the changes!

docs/dev/deployment.md Outdated Show resolved Hide resolved
docs/user/editor/fares.md Outdated Show resolved Hide resolved
docs/user/editor/introduction.md Show resolved Hide resolved
docs/user/editor/routes.md Outdated Show resolved Hide resolved
docs/user/editor/routes.md Outdated Show resolved Hide resolved
docs/user/managing-users.md Outdated Show resolved Hide resolved
docs/user/managing-users.md Outdated Show resolved Hide resolved
docs/user/managing-projects-feeds.md Outdated Show resolved Hide resolved
docs/user/managing-projects-feeds.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@philip-cline philip-cline removed the WIP label Nov 24, 2023
philip-cline
philip-cline approved these changes Dec 11, 2023
View reviewed changes
Copy link
Contributor

@philip-cline philip-cline left a comment

Choose a reason for hiding this comment

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

I added those two files to the nav so that they can be seen in the documentation. Looking good assuming we can get the last photo in the s3 bucket.

@AdrianaCeric
Copy link
Contributor Author

AdrianaCeric commented Dec 11, 2023 •
edited
Loading

Was conflicted between who to assign as second reviewer? Amy for mkdocs styling reasons and/or Binh for datatools knowledge? Feel free to unassign yourself if you don't have capacity

binh-dam-ibigroup
binh-dam-ibigroup approved these changes Dec 13, 2023
View reviewed changes
Copy link
Contributor

@binh-dam-ibigroup binh-dam-ibigroup left a comment

Choose a reason for hiding this comment

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

Looks good, please fix typos and update the product name before proceeding. The CSS and phrasing stuff can be dealt in separate work.

docs/user/editor/patterns.md Outdated Show resolved Hide resolved
docs/user/editor/patterns.md

## Pattern details
<img src="https://datatools-builds.s3.amazonaws.com/docs/patterns/pattern-toolbar.png" style="box-shadow: 3px 3px 3px gray; border-radius: 10px;">
Copy link
Contributor

Choose a reason for hiding this comment

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

For another PR: I think we may be able to move the inline styles to a stylesheet and replace the HTML <img> tags with regular markdown image tags.

Copy link
Contributor

Choose a reason for hiding this comment

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

And perhaps then iframes too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea!

docs/user/editor/patterns.md Outdated Show resolved Hide resolved
docs/user/deploying-feeds.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/user/managing-users.md Outdated Show resolved Hide resolved
docs/user/managing-users.md Show resolved Hide resolved
docs/user/otp-deployment.md Outdated Show resolved Hide resolved
docs/user/otp-deployment.md Outdated Show resolved Hide resolved
docs/user/setting-up-aws-servers.md Outdated Show resolved Hide resolved
binh-dam-ibigroup
binh-dam-ibigroup requested changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@binh-dam-ibigroup binh-dam-ibigroup left a comment

Choose a reason for hiding this comment

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

The correct stylized spelling doesn't have hyphen between "data" and "tools", e.g.
"Arcadis TRANSIT-datatools", can you fix that please?

docs/index.md
@@ -1,7 +1,7 @@
# IBI Transit Data Tools (TRANSIT-data-tools)
# Arcadis TRANSIT-data-tools
Copy link
Contributor

Choose a reason for hiding this comment

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

The correct stylized spelling doesn't have hyphen between "data" and "tools"

Suggested change
# Arcadis TRANSIT-data-tools
# Arcadis TRANSIT-datatools

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it does as per: https://www.ibigroup.com/ibi-products/transit-data-tools/

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm okay, I guess other folks have been using it wrong!

@binh-dam-ibigroup
Copy link
Contributor

@AdrianaCeric You should also revert the non-documentation changes that cause the E2E tests to fail.

@AdrianaCeric
Copy link
Contributor Author

@binh-dam-ibigroup I believe these are failing snapshots due to changes in naming?
image
Do you know how to update snapshots in datatools?

@binh-dam-ibigroup
Copy link
Contributor

@binh-dam-ibigroup I believe these are failing snapshots due to changes in naming?

Like I said, for this PR, you should revert the non-documentation changes you made.

binh-dam-ibigroup
binh-dam-ibigroup approved these changes Dec 14, 2023
View reviewed changes
Copy link
Contributor

@binh-dam-ibigroup binh-dam-ibigroup left a comment

Choose a reason for hiding this comment

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

Changes look fine, no other requests at this time!

@AdrianaCeric AdrianaCeric merged commit fc4a7c9 into dev Dec 14, 2023
5 checks passed
@miles-grant-ibigroup miles-grant-ibigroup deleted the new-documentation branch December 14, 2023 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@binh-dam-ibigroup binh-dam-ibigroup binh-dam-ibigroup approved these changes

@philip-cline philip-cline philip-cline approved these changes

Assignees

@AdrianaCeric AdrianaCeric

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@AdrianaCeric @binh-dam-ibigroup @philip-cline @amy-corson-ibigroup