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

reorganize dataset chapters #1363

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

reorganize dataset chapters #1363

wants to merge 6 commits into from

Conversation

ZMAlt
Copy link
Member

@ZMAlt ZMAlt commented Sep 13, 2024

@ZMAlt ZMAlt marked this pull request as draft September 13, 2024 09:07
@seisman
Copy link
Member

seisman commented Sep 13, 2024

这一部分结构是有点乱,是否可以把所有数据相关的内容都放在一章里

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 13, 2024

是的,做这个 pr 的时候感觉仍不好。我想太多的关于数据的一级目录不合适,但太深的目录也不利于查文档。

可能的两种结构
第一种:

  • 地学数据集
    • GMT 内置数据(GSHHG、DCW、 远程数据)
    • 自定义数据(只介绍设置数据库的方法)
    • 全球数据集 (那四种数据)
    • 中国数据集 (社区维护的国内数据)

第二种,但我不知道《自定义数据》这部分应该放在哪里

  • GMT 数据集
    • GSHHG
    • DCW
    • 远程数据
  • 地学数据集
    • 全球
    • 中国

@seisman
Copy link
Member

seisman commented Sep 14, 2024

我在考虑是否可以把所有内容都放在一章里,不再细分。例如:

  • 地学数据
    • 首页:可以有一张表或者一个图库,展示所有数据
    • GSHHG
    • DCW
    • 远程数据
    • GADM
    • CN-faults
    • ...

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 16, 2024

我建议不要把 GMT 数据和其他数据并列的好。并列和当前的 地学数据集 章节类似,还是混在一起的。从 qq 群的用户看,入门级的用户很多,但又很喜欢一上来就用高级功能,这可能会令他们迷茫。

@seisman
Copy link
Member

seisman commented Sep 17, 2024

我在考虑是否可以把所有内容都放在一章里,不再细分。例如:

  • 地学数据

    • 首页:可以有一张表或者一个图库,展示所有数据
    • GSHHG
    • DCW
    • 远程数据
    • GADM
    • CN-faults
    • ...

如果把“远程数据”的具体细节和“自定义数据库”的具体方法都放在附录里,如何?这样所有数据都是并列关系。

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 18, 2024

这样做的话,还有一个问题,目前中文数据是打包在一起的。如果把每条单独数据分出来,就不需要现在能覆盖所有数据并介绍下载的单独 章节,数据打包在一起还是不是合适?把数据下载的说明同时移到每个单独数据中?

实际上,我仍倾向于

  • 地学数据集
    * GMT 内置数据(GSHHG、DCW、 远程数据)
    * 自定义数据(只介绍设置数据库的方法)
    * 全球数据集 (那四种数据)
    * 中国数据集 (社区维护的国内数据)

不过我之前做的几个 commits 的层级现在还不对。

@seisman
Copy link
Member

seisman commented Sep 18, 2024

这样做的话,还有一个问题,目前中文数据是打包在一起的。如果把每条单独数据分出来,就不需要现在能覆盖所有数据并介绍下载的单独 章节,数据打包在一起还是不是合适?把数据下载的说明同时移到每个单独数据中?

实际上,我仍倾向于

  • 地学数据集
    • GMT 内置数据(GSHHG、DCW、 远程数据)
    • 自定义数据(只介绍设置数据库的方法)
    • 全球数据集 (那四种数据)
    • 中国数据集 (社区维护的国内数据)

不过我之前做的几个 commits 的层级现在还不对。

你倾向的目录结构,从写书的角度来说是正确的。但从读者的角度来说,大部分人并不关心数据属于哪一类,更在于有哪些数据。所有数据都放在一个层级,更容易知道有哪些数据是可用的,至于数据是内置的还是社区维护的,并不重要。

这样做的话,还有一个问题,目前中文数据是打包在一起的。如果把每条单独数据分出来,就不需要现在能覆盖所有数据并介绍下载的单独 章节,数据打包在一起还是不是合适?把数据下载的说明同时移到每个单独数据中?

我个人倾向于数据还是打包。至于数据下载和使用方式,则可以在每个单独数据的页面都显示一遍。这样的好处在于,每个数据的介绍都是独立的。

@ZMAlt
Copy link
Member Author

ZMAlt commented Sep 20, 2024

你倾向的目录结构,从写书的角度来说是正确的。但从读者的角度来说,大部分人并不关心数据属于哪一类,更在于有哪些数据。所有数据都放在一个层级,更容易知道有哪些数据是可用的,至于数据是内置的还是社区维护的,并不重要。

make sense.

我可能最近没有很多时间做这个了,但我会尽量把远程数据列表先分出一个单独的 PR 提交。

@ZMAlt ZMAlt changed the title reorganize dataset chapters and add remote datasets list reorganize dataset chapters Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants