-
Notifications
You must be signed in to change notification settings - Fork 4
/
TODO.txt
287 lines (253 loc) · 13.1 KB
/
TODO.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
----------------------
BUG: soft_arch -> ha.* -> *.hardware
BUG: ethereum -> token -> standardss
BUG: dev_ops -> notifications.jenkins must also appear as jenkins.notifications
____________________
BUG: Google search points to:
www.oficina24x7.com/Blockchain/ethereum_map.html?showSearchMenu?topics=101,solidity
Topic solidity has been moved to dev_language.solidity so it doesn't exists anymore
- New searches fail since it will always try to filter by non-existing topics.
-----------------------------------
https://yyhh.org/blog/2020/04/how-to-enable-saml-sso-with-self-hosted-gotrue-and-git-gateway/
https://github.com/netlify/git-gateway
git-gateway enables people to commit content in git without knowing about git <--- !!!!!!
-----------------------------------
- Allow to easily C&P all topics (in order to help classifying new content)
---------------------------------
- Allow proper search for "topic.*".
Each time a new topic. is detected the search engine must add the possibility
to search by any sub-topic and show automatically the "*" option.
When executing search, once detected search by "*" any match by prefix will work.
---------------------------------
- Allow for inverted indexes for topics when the inverted index, seen as a topic
is "important" enough. e.g:
automatically created
jvm.monitoring, -> monitoring.*
app.monitoring,
spring.monitoring,
...
- Question: What about non-symetric topics like:
async/reactive.testing <-> qa.testing.async/reactive
---------------------------------
- When selecting a label in search, automatically mark related ones. (those topics
who match selected label in one or more cells)
---------------------------------
Add warning:
" This page is designed to be used offline and contains
hundred of classified and linked documentation inside.
(Some pages can contain a full text book)
When using mobile devices, give your web browser a
few seconds to download all the content and process
all metadata before start navigating.
Once pre-setup is finished, use the search menu to
filter by topic or free-text!
Thanks for your patience,
The SPB project team!"
----------------------------------------------
- Allow plugin/extension-point to highly others than TODO, for example
"billion-dolar-mistake", ...
----------------------------------------------
https://handshake.org/
https://github.com/tldr-pages/tldr/blob/master/pages/common/hsd-cli.md
https://github.com/tldr-pages/tldr/blob/master/pages/common/hsw-cli.md
Decentralized naming and certificate authority
----------------------------------------------
• text description for topics.
______________________________________________
Remove xsmall by something more meaningful (h1, ...)
---------------------------------------
Add visual "component" diagram:
SPB CMS:
Brower -> docs@A Brower -> Web Server -> DDBB
Brower -> docs@B Brower -> Web Server -> DDBB
______________________________________________
https://github.com/tldr-pages/tldr/blob/master/pages/common/browser-sync.md
Starts local web server that updates browser on file changes. More information: https://browsersync.io/docs/command-line.
______________________________________________
graph JS rendering:
https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29#JavaScript
______________________________________________________
https://www.saltycrane.com/blog/2020/04/how-width-set-css/
https://www.saltycrane.com/blog/2021/01/how-height-set-css/
______________________________________________________
https://aws.amazon.com/getting-started/hands-on/host-static-website/
______________________________________________________
schema.org related types that can help search engines:
· https://schema.org/TechArticle
How-to (task) topics, step-by-step, procedural troubleshooting, specifications, etc.
· https://schema.org/Code
Computer programming source code.
Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
· https://schema.org/Course
A description of an educational course which may be offered as
distinct instances at which take place at different times or take
place at different locations, or be offered through different media
or modes of study. An educational course is a sequence of one or more
educational events and/or creative works which aims to build
knowledge, competence or ability of learners.
· https://schema.org/LearningResource
LearningResource is expected to be used as an addition to a primary type such as Book, VideoObject, Product etc.
· https://schema.org/Map
· https://schema.org/Thesis
·
·
______________________________________________________
- Check escalability → scalability
______________________________________________________
- Review demo links.
- Change also UUIDs
______________________________________________________
SPB Doc: add doc. about "patchy" solution ˂˃ (vs >/<)
______________________________________________________
- Add Support for Mermaid Graphs:
https://mermaid-js.github.io/mermaid/#/
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
- Doing so will command the mermaid parser to look for the <div> tags
with class="mermaid". From these tags mermaid will try to read the
diagram/chart definitons and render them into svg charts.
______________________________________________________
SPB introduction: Add relation/comparative to https://etherpad.org/
______________________________________________________
Page load profiling:
https://developers.google.com/speed/pagespeed/insights/?url=http%3A%2F%2Fwww.oficina24x7.com%2FBlockchain%2Fethereum_map.html%3FshowSearchMenu%3Dtrue
______________________________________________________
- Improve demo
______________________________________________________
- When clicking on a given tag allow to show related tags with matching
coindicences. For example, when clicking on "persistence" show related
tags like "storage"[20 matches], "serialization"[3 matches], ...
______________________________________________________
- when a query like ...?topics=NonExistingTopic is selected there is
no way in UI to un-select the non-existing-topic and an empty result
is show for "AND" searchs.
______________________________________________________
Add also standard meta-topics:
TODO, important, ...
Example programming classification to allow N dimensional searchs :
· CLASSIFICATION 1 (General) : pending, important, urgent, blocking, ?
· CLASSIFICATION 2 (doc.nature) : tutorial (howto, ...), config, procedure, report, links new, log,
code, anex, bill/invocice/delivery_note, budget, estimation, ...
· CLASSIFICATION (dificulty) : dif1 -> dif2 -> ... -> dif10
· CLASSIFICATION 2 (Soft LifeCicle): tools -> documentation -> development -> debugging ->
validation (unitests, functional, ...) -> close
-> IOP (dev,tst,pre,beta,pro) -> monitorización -> incidencias -> QA
· CLASSIFICATION 4 (Environement) : DEV, TST, PRE, PRO
· CLASSIFICATION 5 (Product) : product1, product2, ...
· CLASSIFICATION 9 (prog.Lang) : javascript, java, batch, ruby, shell, Silverlight, python, ?
· CLASSIFICATION 12 (Roll) : Programmer, Analist, DevOps, manager, ?
· CLASSIFICATION 13(lecture time) : 7min -> 15min -> 30min -> 1h -> 4h -> 1d -> 1w -> 1m
· ..
General taxonomies:
{ IT : [ performance, redundancy, log, monitoring,
analytics, testing, CI, IaC, ...],
documentacion : ... }
______________________________________________________
Allow to add titles for topics. Ex:
{ "101": "Info for newcommers, must-know, ...",
"transaction": "TXs signed by clients sent to node ...",
... }
______________________________________________________
Allow to order topics by family:
(meta-topics of topics)
Allow dev mode so that page is reloaded with existing layout (open note)
______________________________________________________
Allow to search by "glummed/nearby tags":
- This requires first to define what is a "nearby tag".
______________________________________________________
Allot to use variables inside links. For example:
@[http://${AZURE_ARTICLES}/azure-preview-portal-using-resource-groups/]
instead of:
@[http://azure.microsoft.com/en-us/documentation/articles/azure-preview-portal-using-resource-groups/]
______________________________________________________
Allow to change pre white-space css in case of overflow:
REF: https://stackoverflow.com/questions/7138772/how-to-detect-overflow-in-div-element
______________________________________________________
Internal search must invoque the query directly
(not reload the page if possible)
------------------------------------------
Allow to open "popup" in new window
------------------------------------------
https://stackoverflow.com/questions/13955163/imitating-a-blink-tag-with-css3-animations
------------------------------------------
https://www.infoq.com/news/2019/03/flexsearch-fast-full-text-search
C&P from https://www.infoq.com/news/2019/03/flexsearch-fast-full-text-search/
... in a given amount of time, 300 times more search operations than Wade,
the next fastest search library.
- Typical basic full-text search features include:
- stemming : Ex. 'caring' matches 'care'
- stopword handling : avoid irrelevant results (remove articles, common words,...)
- phrase matching : control how much distance can be allowed between words
- basic fuzzy matching:
- autocomplete :
- suggestions :
- search expressions :
- synonym search :
------------------------------------------
Highperf code editor for the web:
https://ace.c9.io
https://stackoverflow.com/questions/15485153/enable-vim-mode-in-gist-ace-editor
- https://codepen.io/buglessir/pen/EJQZWW
JS: Save/download blob as file
______________________________________________
href rel attribute:
https://www.w3schools.com/TAGS/att_a_rel.asp
<a rel="value">
Value Description
------------ ----------------------------------
alternate Provides a link to an alternate representation
of the document (i.e. print page, translated or mirror)
author Provides a link to the author of the document
bookmark Permanent URL used for bookmarking
external Indicates that the referenced document is not part of the
same site as the current document
help Provides a link to a help document
license Provides a link to copyright information for the document
next Provides a link to the next document in the series
nofollow Links to an unendorsed document, like a paid link.
used by Google to specify that the Google search spider
should not follow that link.
noreferrer Requires that the browser should not send an HTTP referer
header if the user follows the hyperlink
noopener Requires that any browsing context created by following
the hyperlink must not have an opener browsing context
prev The previous document in a selection
search Links to a search tool for the document
tag A tag (keyword) for the current document
_______________
https://www.zotero.org/
Your personal research assistant
Zotero is a free, easy-to-use tool to help you collect,
organize, cite, and share research.
_______________
SEO,Rich Structured Data for Search Engines:
https://www.infoq.com/news/2021/02/seo-structured-data-rich-snippet/
----------------------------------------------
Add share icon.
----------------------------------------------
pack js/css into html:
https://github.com/mahhov/inline-scripts/blob/master/src/inlineScriptTags.js
-----------------------------------------------
https://lunrjs.com/
Simple
Designed to be small, yet full featured, Lunr enables you to provide a great search experience without the need for external, server-side, search services.
Extensible
Add powerful language processors to give more accurate results to user queries, or tweak the built-in processors to better fit your content.
Everywhere
Lunr has no external dependencies and works in your browser or on the server with node.js
______________________________________________
Six Degrees of Wikipedia [ENG]
https://www.meneame.net/story/six-degrees-of-wikipedia-eng
Inspirado en el concepto de seis grados de separación, Six Degrees
of Wikipedia recorre los hipervínculos de Wikipedia para encontrar
el menor número de clics que se necesitan para navegar entre
cualquiera de los casi seis millones de páginas de la mayor
enciclopedia gratuita en línea del mundo. Introduce los títulos de
dos páginas de Wikipedia en las casillas de este sitio, haz clic en
el botón "Go!" y descubre lo conec
____________________________________________
Loading modules like:
<script type="module">
import("/IT_notes/map_v1.bundle.js").catch(() => { import("/IT_notes/map_v1.js") } )
</script>
works on on Firefox Desktop/mobile and Chrome desktop. Fails on Chrome mobile :( !!!