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

Cache docs in local database & topic labels. #2826

Merged
merged 7 commits into from
Feb 17, 2020

Conversation

maliming
Copy link
Member

@maliming maliming commented Feb 14, 2020

Resolve #2805 , resolve #1994

  1. Store Document and DocumentContributors as entities into the database. Documents have different language codes and versions. Rename IDocumentStore to IDocumentSource.

  2. Determine whether the file is Updor New according to the file's commits.

  1. Added file last modified time and contributor information.

image

  1. We can pull single or all documents in project management. Will replace documents in the database.

image

image

@maliming maliming requested a review from hikalkan February 14, 2020 09:22
@gterdem
Copy link
Contributor

gterdem commented Feb 14, 2020

Added file last modified time and contributor information.

I want to suggest enhancement about this topic;
What do you think about new changes have different background color on UI for the duration of upd label so it could be easier to notice?

@maliming maliming closed this Feb 14, 2020
@maliming maliming reopened this Feb 15, 2020
@maliming maliming removed the request for review from hikalkan February 15, 2020 05:57
@maliming maliming added this to the 2.1 milestone Feb 15, 2020
@maliming maliming requested a review from hikalkan February 17, 2020 09:00
@maliming
Copy link
Member Author

What do you think about new changes have different background color on UI for the duration of upd label so it could be easier to notice?

image

@hikalkan hikalkan merged commit b9a36f6 into dev Feb 17, 2020
@maliming maliming deleted the maliming/cache_docs_in_local_database branch February 17, 2020 14:10
@Ice2burn
Copy link

Ice2burn commented Feb 17, 2020

Will topic be marked as UPD If you edit a typo after 30 days?

@hikalkan
Copy link
Member

We were discussing it today :) We'll try to find a proper way (like the amount of the edit). If you have a good suggestion, it is appreciated.

@Ice2burn
Copy link

I was thinking about settings this up manually in Navigation Document. New json section "labels" or parameter "label" for example. And this problem will be closed for json-based documentation. Hovewer there is a chance that developer will forget to mark upper level nodes, but it's not your problem :)

In terms of github-based documentation, I need a bit of research to see what info available. I think New and Upd labels should appear only after version change. So checking edit date is not enough.

@hikalkan
Copy link
Member

Following with #2843

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cache documents in the local database for the documents module Documentation: topic labels
5 participants