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

Change legacy backend related + parser docs #3419

Merged
merged 4 commits into from
Apr 22, 2022
Merged

Change legacy backend related + parser docs #3419

merged 4 commits into from
Apr 22, 2022

Conversation

TueeNguyen
Copy link
Contributor

Issue This PR Addresses

Part of #2777
This PR fixes the docs only

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

Steps to test the PR

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@gitpod-io
Copy link

gitpod-io bot commented Apr 7, 2022

@TueeNguyen TueeNguyen changed the title Move backend 3 Change legacy backend related docs Apr 7, 2022
menghif
menghif requested changes Apr 7, 2022
View reviewed changes
Copy link
Contributor

@menghif menghif left a comment •
edited
Loading

Choose a reason for hiding this comment

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

You should remove legacy monolithic back-end (1.0) from the "Current Design" section and also change the Telescope version to 3.0:

telescope/src/web/docusaurus/docs/architecture.md

Line 19 in c66bcf4

The following gives an overview of the current (i.e. 2.4.0) design of Telescope. There are a number of major systems that make up the app:

telescope/src/web/docusaurus/docs/architecture.md

Line 21 in c66bcf4

- legacy monolithic back-end (1.0)

@TueeNguyen TueeNguyen self-assigned this Apr 8, 2022
@TueeNguyen TueeNguyen added this to the 3.0 Release milestone Apr 8, 2022
@TueeNguyen
Copy link
Contributor Author

For release 3.0 alpha, we should focus on other feature PRs, this PR on doc changes can go in after. I've moved to 3.0

@sirinoks sirinoks added review: easy type: documentation (docs) Improvements or additions to documentation labels Apr 19, 2022
@TueeNguyen
Copy link
Contributor Author

I've fixed the docs, ready for another round of reviews

JiaHua-Zou
JiaHua-Zou reviewed Apr 20, 2022
View reviewed changes
src/api/parser/README.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/parser.md Outdated Show resolved Hide resolved
@TueeNguyen TueeNguyen changed the title Change legacy backend related docs Change legacy backend related + parser docs Apr 20, 2022
JiaHua-Zou
JiaHua-Zou previously approved these changes Apr 20, 2022
View reviewed changes
@humphd humphd dismissed stale reviews from AmasiaNalbandian and JiaHua-Zou via 9644697 April 20, 2022 17:46
@sirinoks sirinoks mentioned this pull request Apr 21, 2022
Closed
8 tasks
@TueeNguyen TueeNguyen removed this from the 3.0 Release milestone Apr 22, 2022
@JerryHue JerryHue added this to the 3.0 Release milestone Apr 22, 2022
@TueeNguyen TueeNguyen merged commit 0af6725 into Seneca-CDOT:master Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sirinoks sirinoks sirinoks approved these changes

@JerryHue JerryHue JerryHue approved these changes

@JiaHua-Zou JiaHua-Zou JiaHua-Zou approved these changes

@AmasiaNalbandian AmasiaNalbandian AmasiaNalbandian left review comments

@humphd humphd Awaiting requested review from humphd

@cindyorangis cindyorangis Awaiting requested review from cindyorangis

@menghif menghif Awaiting requested review from menghif

@dbelokon dbelokon Awaiting requested review from dbelokon

Assignees

@TueeNguyen TueeNguyen

Labels
type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Milestone
3.0 Release
Development

Successfully merging this pull request may close these issues.
7 participants
@TueeNguyen @sirinoks @menghif @JerryHue @JiaHua-Zou @dbelokon @AmasiaNalbandian