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

Documentation Restructure #142

Merged
merged 29 commits into from
Apr 10, 2024
Merged

Documentation Restructure #142

merged 29 commits into from
Apr 10, 2024

Conversation

pavithraes
Copy link
Collaborator

@pavithraes pavithraes commented Mar 13, 2024 •
edited
Loading

Fixes #111

Preview: https://github.com/pavithraes/csp/wiki

Note:

  • The structure has diverged a fair bit from the initial proposal
  • The Getting Started tutorials will cover a lot of csp.baselib usage details, hence it's not a huge focus in the concepts section (→ Already tracking in a separate issue)
  • The "How-to" guides only have the migrated content from old docs right now, we'll be updating all the pages to follow a "how-to" format (→ Opened a new issue)
  • The docs authoring workflow will change a little with the new GitHub sidebar, we'll add relevant docs to make this easier

This PR has an initial structure. It'll need some updates, but those will be easier to do after merging.

@pavithraes
🗑️ Remove all files from docs/wiki
41bb295 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
✨ Add initial restructured files and folders
be67c62 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes pavithraes added the part: documentation Improvements/bugs/changes to documentation label Mar 13, 2024
@pavithraes
🧹 Lint and format docs
f0d021b 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@timkpaine timkpaine changed the title [WIP] Documentation Restrucutre [WIP] Documentation Restructure Mar 18, 2024
@pavithraes
📝 Split How to Write Adpaters
5a4a42e 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
📝 Move graph_info from how-to to api-reference
1c920bb 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
📝 Remove release notes from sidebar
b4f4774 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
🧹 Fix Local-Development-Setup file extension
9573bd8 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
🧹 Fix typo in TOC
d9c434a 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes pavithraes changed the title [WIP] Documentation Restructure Documentation Restructure Mar 18, 2024
@pavithraes pavithraes marked this pull request as ready for review March 18, 2024 17:07
melissawm
melissawm previously approved these changes Mar 18, 2024
View reviewed changes
Copy link
Collaborator

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

This looks good to me, I left a few nits but I will leave my approval already as I agree with the general structure. Thanks @pavithraes !

docs/wiki/_Sidebar.md Outdated Show resolved Hide resolved
docs/wiki/api-references/Statistical-Nodes-API.md Show resolved Hide resolved
docs/wiki/_Sidebar.md Outdated Show resolved Hide resolved
@robambalu
Copy link
Collaborator

Whats the best way to preview this? I see you have the link posted from last week, is it up to date?

@trallard
Copy link
Collaborator

@robambalu, yes, using the preview link at https://github.com/pavithraes/csp/wiki would be the best way to see the current new structure.

@robambalu
Copy link
Collaborator

@trallard to be clear, would that just show the structure or would it have the latest edits too so I can comment as I read through it?
It looks like it was last regenerated last week

@pavithraes
Copy link
Collaborator Author

@robambalu Yes, I'm keeping https://github.com/pavithraes/csp/wiki up-to-date with this PR at all times. Some pages (like the home page) haven't had any updates for a week, which is why you see that message. But, for example, the Write Output Adapters page shows the recent edits from 2 days ago. :)

@pavithraes @melissawm
Apply suggestions from code review
f919430 
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
📝 update toc in stats node api ref
229c5ff 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
🔁 Merge main branch
29e209b 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
📝 Update Home.md
27d2fbe 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
robambalu
robambalu reviewed Mar 20, 2024
View reviewed changes
docs/wiki/Home.md Outdated Show resolved Hide resolved
docs/wiki/concepts/CSP-Graph.md Show resolved Hide resolved
docs/wiki/concepts/CSP-Node.md Outdated Show resolved Hide resolved
docs/wiki/concepts/CSP-Node.md Outdated Show resolved Hide resolved
docs/wiki/concepts/CSP-Node.md Outdated Show resolved Hide resolved
docs/wiki/concepts/Historical-Data.md Outdated Show resolved Hide resolved
docs/wiki/concepts/Historical-Data.md Outdated Show resolved Hide resolved
docs/wiki/concepts/Execution-Modes.md Show resolved Hide resolved
docs/wiki/api-references/Base-Nodes-API.md Outdated Show resolved Hide resolved
docs/wiki/dev-guides/Roadmap.md Outdated Show resolved Hide resolved
@melissawm
Rename Glossary file and fix reference
5d4d865 
Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
@melissawm
Fix reference to docs folder in footer
4ffc649 
Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
@melissawm melissawm force-pushed the pavithraes/docs-restructure branch from 144dcab to 4ffc649 Compare April 1, 2024 13:15
melissawm and others added 6 commits April 1, 2024 14:11
@melissawm
Fix CSP capitalization and formatting for code display.
8ba9c7e 
Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
@melissawm
Add installation instructions with conda for Linux and Mac
c770bc0 
Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
@melissawm
Change typing notation for consistency, add note about notation
12827ae 
Signed-off-by: Melissa Weber Mendonça <melissawm@gmail.com>
@pavithraes
Merge 'main' into pavithraes/docs-restructure
64e0a65 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Add more terms to the Glossary
7573d10 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Fix linting errors
9a14d23 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@robambalu
Copy link
Collaborator

@pavithraes can we remove this section all together if you havent already: https://github.com/Point72/csp/wiki/9.-Caching
We dont plan to maintain that ( in its current form )

robambalu
robambalu reviewed Apr 5, 2024
View reviewed changes
docs/wiki/concepts/Historical-Data.md Outdated Show resolved Hide resolved
docs/wiki/concepts/CSP-Node.md Outdated Show resolved Hide resolved
docs/wiki/concepts/Caching.md Outdated Show resolved Hide resolved
docs/wiki/dev-guides/Release-Process.md Show resolved Hide resolved
@robambalu
Update historical buffers examples
599fff5 
Signed-off-by: Rob Ambalu <robert.ambalu@point72.com>
robambalu and others added 2 commits April 5, 2024 15:40
@robambalu
placate the mdformat gds
5be0393 
Signed-off-by: Rob Ambalu <robert.ambalu@point72.com>
@pavithraes
✨ Updates from code review
205db20 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Copy link
Collaborator Author

@robambalu - I've made all the requested updates, this is ready for a final look :)

@pavithraes
Remove Caching from sidebar
ed4c93b 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Update headings for base nodes and adapaters API references
105681b 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Update the roadmap
5a5758d 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes
Fix wording in roadmap
1c444cf 
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@robambalu robambalu self-requested a review April 10, 2024 17:24
@robambalu robambalu merged commit bd82454 into main Apr 10, 2024
11 checks passed
@robambalu robambalu deleted the pavithraes/docs-restructure branch April 10, 2024 17:41
@pavithraes pavithraes restored the pavithraes/docs-restructure branch April 18, 2024 14:20
@timkpaine timkpaine deleted the pavithraes/docs-restructure branch April 23, 2024 07:42
Carreau added a commit to Carreau/csp that referenced this pull request May 13, 2024
@Carreau
Merge pull request Point72#142 from Point72/pavithraes/docs-restructure
faee778 
Documentation Restructure
Carreau added a commit to Carreau/csp that referenced this pull request May 13, 2024
@Carreau
Rewritten branch Empty commit.
b99ee3c 
This is an empty commit, it is kept for information purposes.

This is a rewritten branch, that squash the content of PR Point72#142 into a
single commit (keeping a merge commit).

Due to the merkel tree nature of git, all the subsequent commits have
been rewritten, have a different hash and so it will need a force push.

For completeness here is the current list of commits on main that have
been rewritten and their new counterpart:

    old     new
    e1e1f82 7b3c3a7 : Python 3.12 build support (Point72#221)
    a32cef3 2abdf59 : Update vcpkg baseline (Point72#209)
    8bae523 c51a86b : Merge pull request Point72#189 from Point72/pavithraes/fix-links
    0964fad 7a25f45 : Merge pull request Point72#219 from Point72/wrr/fix_ws_json_mapper
    755debf cc60b87 : Merge pull request Point72#191 from Point72/ac/fix_to_json_parsing_floats
    5c7e55f ba90a02 : Merge pull request Point72#200 from Point72/tkp/docs
    2568689 abcd307 : Move websocket example after merge
    f9b7e62 da4d5e3 : fix format changes that will now result in lint failures
    687dc2e d6479c5 : Upgrade CSP to C++20; build websocket against C++17; rename .hi files (Point72#224)
    9b442d5 8adb1a7 : Upgrade baseline in vcpkg.json
    92b7e34 d9ac41d : Pin linters to narrow range to avoid noise
    ee1aaf2 f11b8fc : PushPullInputAdapter - fix to previous patch that fixed out of order time handling.  Need to account for the null event which signifies end of replay
    fef2fac 68927fe : Update to arrow / pyarrow 16 (Point72#210)
    4717f54 086c9d5 : Add placeholder block to build action for service tests (in another PR)
    306a530 ef1a239 : Merge pull request Point72#195 from Point72/bugfix/push_pull_ooo_patch
    fc239d5 4ea4799 : Maintain the type of a list-derived object when converting a struct in to_dict (Point72#199)
    adc79fd f6b0963 : Parse None natively in to_json method
    3871e4a df3bb2d : Merge pull request Point72#196 from Point72/revert-194-ac/upgrade_vcpkg_43d81795a
    6c57fb3 8a0d881 : Remove all caching code from CSP (Point72#213)
    9729984 e70e4d7 : Merge pull request Point72#174 from Point72/tkp/slacktut
    964c77e 12cceeb : Merge pull request Point72#223 from Point72/tkp/lint
    801aa60 86c4e6d : Revert "Upgrade baseline in vcpkg.json"
    7b07bea 64559cb : Include AS statement in SQL build query regardless of sqlalchemy version (Point72#205)
    4621584 5103026 : Re-apply lost updates in dev guides (Point72#202)
    5cde2c7 68dda2f : Merge pull request Point72#192 from Point72/ac/parse_none_to_json
    6b4f38b efe0fd6 : Add format check to lint step
    4a7dc36 eaec4a0 : Update baseline to stable version
    c5acdc8 3ca95b3 : Merge pull request Point72#194 from Point72/ac/upgrade_vcpkg_43d81795a
    00c2a06 471e142 : Run autofixers with pinned up packages
    b748dc7 7441fb5 : Add build-debug option to Makefile so we dont forget the proper incantations (Point72#222)
    24c5818 89eda4c : fix @217 | add tests
    96a47b9 118a2fb : Fix to_json serialization for floats
    895563c 78e7aca : Merge pull request Point72#211 from Point72/tkp/checklint
    063b137 e2a4f2b : Fix interrupt handling issues in csp: ensure first node is stopped and reset signaled flag across runs (Point72#206)
    7197c77 da9a84f : minor bugfix to unroll cppimpl.  Missing cast from vector value to ElemT, which for bool would be a vector value of unsigned char.  This was triggering a CSP_ASSERT in debug builds

With the exception of the squashed one :

    faee778 : Merge pull request Point72#142 from Point72/pavithraes/docs-restructure
                that is a squash of all of Point72#142

All commits before that until 5d7eeb are unchanged

You can use the following command using this commit message to check
each of those commits vs their counterpart:

```
$ git show HEAD |tail -n +16 |head -n 35 | cut -f 1 -d: | xargs -L1 git diff --stat
```
@Carreau Carreau mentioned this pull request May 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timkpaine timkpaine timkpaine left review comments

@melissawm melissawm melissawm left review comments

@robambalu robambalu robambalu approved these changes

@AdamGlustein AdamGlustein Awaiting requested review from AdamGlustein AdamGlustein is a code owner

@svatasoiu svatasoiu Awaiting requested review from svatasoiu svatasoiu is a code owner

@alexddobkin alexddobkin Awaiting requested review from alexddobkin alexddobkin is a code owner

@ptomecek ptomecek Awaiting requested review from ptomecek

Assignees
No one assigned
Labels
part: documentation Improvements/bugs/changes to documentation tag: needs squash PRs that need to be cleaned/squashed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Restructure the documentation
6 participants
@pavithraes @robambalu @trallard @timkpaine @melissawm @ptomecek