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

Community Updates - ROADMAP/README #1867

Merged
merged 6 commits into from
Jul 9, 2021
Merged

Community Updates - ROADMAP/README #1867

merged 6 commits into from
Jul 9, 2021

Conversation

calvincestari
Copy link
Member

@calvincestari calvincestari commented Jul 8, 2021

These changes are focussed on public community facing documentation:

  1. Update the roadmap document inline with the latest planning. You can view this as rendered Markdown with this link. Closes Update ROADMAP.md #1863
  2. I've also taken the liberty to 'improve' the readme; subjective improvements. You can view this as rendered Markdown with this link.
    • Uses HTML tags to get centered content - much nicer visually.
    • I think it's important to have Apollo branding on the project and identify stewardship beyond just maintainers.
    • Provide clarity on supported platforms - specifically the omission of Linux.
    • Add a link directly to the tutorial which I'm hoping is an easier entry point for those new to GraphQL and this project.
    • Increase visibility to the roadmap beyond just a file in the repo.

- Adds branding
- Clarify platform support
- Add roadmap visibility
- Update tooling versions
@calvincestari calvincestari added the no-changelog Indicates that changes from this PR do not need to be included in the changelog for their release. label Jul 8, 2021
ROADMAP.md Outdated Show resolved Hide resolved

These are things we plan to be working on **beyond the next 3 months**.
These are subject to change and anything that dramatically changes APIs or breaks backwards compatibility with 1.x releases will be reserved for the next major version.
Copy link
Member Author

Choose a reason for hiding this comment

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

Let me know if there is anything else we want to specifically call attention to as something we'll be looking at in future versions.

Copy link
Contributor

Choose a reason for hiding this comment

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

This looks like a good list from my perspective!

README.md Show resolved Hide resolved

^ If that's more than three months ago, please file an issue asking [@designatednerd](https://github.com/designatednerd) to update this document. 😃
Copy link
Contributor

Choose a reason for hiding this comment

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

Personally, I'd leave in the thing about annoy us with an issue if it's been more than 3 months since it was last updated, just to keep us honest, but that's up to you and @AnthonyMDev

Copy link
Member Author

Choose a reason for hiding this comment

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

For sure, never a bad thing to have accountability. Done in 4b6d88d.


These are things we plan to be working on **beyond the next 3 months**.
These are subject to change and anything that dramatically changes APIs or breaks backwards compatibility with 1.x releases will be reserved for the next major version.
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks like a good list from my perspective!

ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
ROADMAP.md Outdated Show resolved Hide resolved
@calvincestari calvincestari merged commit abf1ece into main Jul 9, 2021
@calvincestari calvincestari deleted the community-updates branch July 9, 2021 22:05
@calvincestari calvincestari added this to the MM-2021-07 milestone Jul 20, 2021
@hwillson hwillson removed this from the MM-2021-07 milestone Jul 29, 2021
ketenshi added a commit to scorebet/apollo-ios that referenced this pull request Aug 16, 2021
* main: (856 commits)
  Add execution tests for ApolloClient clearCache callback queue (apollographql#1901)
  Use the provided callback queue instead of the store's default. (apollographql#1904)
  chore(deps): update dependency path-parse to 1.0.7 [security] (apollographql#1899)
  Release - 0.46.0 (apollographql#1897)
  Update subscriptions tutorial to be compatible with recent changes (apollographql#1893)
  Add docs and improve merging of records from WebSockets into cache. (apollographql#1892)
  Publish response from the `WebSocketTransport` to the `ApolloStore` (apollographql#1889)
  fix(deps): update dependency gatsby-theme-apollo-docs to v4.7.14
  Removing Swift codegen (v1) (apollographql#1873)
  Update toolchain versions used by circleci (apollographql#1875)
  fix(deps): update dependency gatsby-theme-apollo-docs to v4.7.13
  Community Updates - ROADMAP/README (apollographql#1867)
  [Release] - 0.45.0 (apollographql#1862)
  WebSocket Fixes - Revert to Starscream 3.x and invert dependency (apollographql#1861)
  Docs/discussions_2_community branch changes (apollographql#1858)
  Replace spectrum with Discourse (apollographql#1857)
  fix(deps): update dependency gatsby-theme-apollo-docs to v4.7.12
  Configure Renovate (apollographql#1854)
  Revert "Reconfiguring renovate 2/2"
  Reconfiguring renovate 2/2
  ...

# Conflicts:
#	Sources/Apollo/GraphQLQueryWatcher.swift
#	Sources/ApolloWebSocket/WebSocketTransport.swift
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Indicates that changes from this PR do not need to be included in the changelog for their release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update ROADMAP.md
5 participants