search

filecoin-project / specs

The Filecoin protocol specification
https://spec.filecoin.io
Other
367 stars 170 forks source link

make sure dashboard properties are using new labels #1078

Closed hugomrdias closed 4 years ago

hugomrdias commented 4 years ago

Starting from this PR https://github.com/filecoin-project/specs/pull/1077 we changed the labels for dashboardState and dashboardAudit, some files already have the new labels but we'r still missing some.

Tips:

olizilla commented 4 years ago

for dashboardAudit 0 is still in use in a bunch. These should be set to missing

❖ ~/Code/filecoin-project/specs/content on dashboard-ui-fixes* 
⨎ grep -r "dashboardAudit:" . | grep 0
./appendix/network_params.md:dashboardAudit: 0
./appendix/sharray.md:dashboardAudit: 0
./appendix/address.md:dashboardAudit: 0
./appendix/_index.md:dashboardAudit: 0
./listings/data_structures.md:dashboardAudit: 0
./listings/system_map.md:dashboardAudit: 0
./listings/libp2p_protocols/data_transfer_protocol.md:dashboardAudit: 0
./listings/libp2p_protocols/_index.md:dashboardAudit: 0
./listings/reserved_ranges.md:dashboardAudit: 0
./listings/actors.md:dashboardAudit: 0
./listings/_index.md:dashboardAudit: 0
./algorithms/post/proof_of_spacetime_parameters.org:#+dashboardAudit: 0
./libraries/filcrypto/_index.md:dashboardAudit: 0
./glossary/_index.md:dashboardAudit: 0

for dashboardState we have a bunch still using incomplete which should be marked as wip

⨎ grep -r "dashboardState:" . | grep incomplete
./appendix/network_params.md:dashboardState: incomplete
./appendix/sharray.md:dashboardState: incomplete
./appendix/address.md:dashboardState: incomplete
./appendix/_index.md:dashboardState: incomplete
./listings/data_structures.md:dashboardState: incomplete
./listings/system_map.md:dashboardState: incomplete
./listings/libp2p_protocols/data_transfer_protocol.md:dashboardState: incomplete
./listings/libp2p_protocols/_index.md:dashboardState: incomplete
./listings/reserved_ranges.md:dashboardState: incomplete
./listings/actors.md:dashboardState: incomplete
./listings/_index.md:dashboardState: incomplete
./glossary/_index.md:dashboardState: incomplete
./systems/filecoin_mining/storage_proving/sealer/_index.md:dashboardState: incomplete
./systems/filecoin_mining/storage_proving/poster/_index.md:dashboardState: incomplete
./systems/filecoin_mining/storage_proving/_index.md:dashboardState: incomplete
./systems/filecoin_markets/storage_market/storage_market_actor.md:dashboardState: incomplete
./systems/filecoin_markets/storage_market/storage_client.md:dashboardState: incomplete
./systems/filecoin_markets/storage_market/_index.md:dashboardState: incomplete
./systems/filecoin_vm/runtime/gascost/_index.md:dashboardState: incomplete
olizilla commented 4 years ago

valid values for dashboardState are "missing", "incorrect", "wip", "reliable", "stable" or "n/a"

current values for dashboardState are:

⨎ grep -r "dashboardState:" . | column -t -s " "
./appendix/network_params.md:dashboardState:                                                   incomplete
./appendix/sharray.md:dashboardState:                                                          incomplete
./appendix/address.md:dashboardState:                                                          incomplete
./appendix/_index.md:dashboardState:                                                           incomplete
./intro/filecoin_vm.md:dashboardState:                                                         reliable
./intro/concepts.md:dashboardState:                                                            reliable
./intro/arch.md:dashboardState:                                                                reliable
./intro/systems/impl_systems.md:dashboardState:                                                reliable
./intro/systems/why_systems.md:dashboardState:                                                 reliable
./intro/systems/_index.md:dashboardState:                                                      reliable
./intro/_index.md:dashboardState:                                                              reliable
./listings/data_structures.md:dashboardState:                                                  incomplete
./listings/system_map.md:dashboardState:                                                       incomplete
./listings/libp2p_protocols/data_transfer_protocol.md:dashboardState:                          incomplete
./listings/libp2p_protocols/_index.md:dashboardState:                                          incomplete
./listings/reserved_ranges.md:dashboardState:                                                  incomplete
./listings/actors.md:dashboardState:                                                           incomplete
./listings/_index.md:dashboardState:                                                           incomplete
./algorithms/cryptoecon/_index.md:dashboardState:                                              incorrect
./algorithms/crypto/signatures.md:dashboardState:                                              wip
./algorithms/crypto/vrf.md:dashboardState:                                                     incorrect
./algorithms/crypto/randomness.md:dashboardState:                                              reliable
./algorithms/crypto/_index.md:dashboardState:                                                  wip
./algorithms/post/election_post.md:dashboardState:                                             incorrect
./algorithms/post/proof_of_spacetime_parameters.org:#+dashboardState:                          incorrect
./algorithms/post/_index.md:dashboardState:                                                    wip
./algorithms/sdr/notation.md:dashboardState:                                                   stable
./algorithms/sdr/_index.md:dashboardState:                                                     stable
./algorithms/payment_channels.md:dashboardState:                                               wip
./algorithms/expected_consensus/_index.md:dashboardState:                                      reliable
./algorithms/block_sync.md:dashboardState:                                                     stable
./algorithms/_index.md:dashboardState:                                                         wip
./algorithms/gossip_sub.md:dashboardState:                                                     wip
./libraries/fcs/_index.md:dashboardState:                                                      missing
./libraries/ipfs/unixfs.md:dashboardState:                                                     missing
./libraries/ipfs/bitswap.md:dashboardState:                                                    missing
./libraries/ipfs/graphsync.md:dashboardState:                                                  missing
./libraries/ipfs/_index.md:dashboardState:                                                     wip
./libraries/drand/_index.md:dashboardState:                                                    stable
./libraries/ipld/cid.md:dashboardState:                                                        wip
./libraries/ipld/selectors.md:dashboardState:                                                  missing
./libraries/ipld/datamodel.md:dashboardState:                                                  missing
./libraries/ipld/_index.md:dashboardState:                                                     missing
./libraries/filcrypto/filproofs/_index.md:dashboardState:                                      incorrect
./libraries/filcrypto/_index.md:dashboardState:                                                wip
./libraries/_index.md:dashboardState:                                                          wip
./libraries/libp2p/kad_dht.md:dashboardState:                                                  missing
./libraries/libp2p/gossipsub.md:dashboardState:                                                missing
./libraries/libp2p/_index.md:dashboardState:                                                   missing
./libraries/libp2p/fil_libp2p_nodes.md:dashboardState:                                         missing
./libraries/multiformats/_index.md:dashboardState:                                             missing
./glossary/_index.md:dashboardState:                                                           incomplete
./systems/filecoin_files/file/filestore.md:dashboardState:                                     reliable
./systems/filecoin_files/file/_index.md:dashboardState:                                        reliable
./systems/filecoin_files/serialization/_index.md:dashboardState:                               reliable
./systems/filecoin_files/data_transfer/_index.md:dashboardState:                               wip
./systems/filecoin_files/piece/piece_store.md:dashboardState:                                  reliable
./systems/filecoin_files/piece/_index.md:dashboardState:                                       wip
./systems/filecoin_files/_index.md:dashboardState:                                             reliable
./systems/filecoin_mining/sector_index/sector_store.md:dashboardState:                         wip
./systems/filecoin_mining/sector_index/sector_builder.md:dashboardState:                       incorrect
./systems/filecoin_mining/sector_index/_index.md:dashboardState:                               incorrect
./systems/filecoin_mining/storage_mining/storage_miner_actor.md:dashboardState:                incorrect
./systems/filecoin_mining/storage_mining/mining_cycle/index.md:dashboardState:                 incorrect
./systems/filecoin_mining/storage_mining/_index.md:dashboardState:                             incorrect
./systems/filecoin_mining/sector/sealing.md:dashboardState:                                    wip
./systems/filecoin_mining/sector/lifecycle.md:dashboardState:                                  reliable
./systems/filecoin_mining/sector/sectorset.md:dashboardState:                                  incorrect
./systems/filecoin_mining/sector/posting.md:dashboardState:                                    incorrect
./systems/filecoin_mining/sector/_index.md:dashboardState:                                     reliable
./systems/filecoin_mining/storage_proving/sealer/_index.md:dashboardState:                     incomplete
./systems/filecoin_mining/storage_proving/poster/_index.md:dashboardState:                     incomplete
./systems/filecoin_mining/storage_proving/_index.md:dashboardState:                            incomplete
./systems/filecoin_mining/_index.md:dashboardState:                                            wip
./systems/filecoin_blockchain/storage_power_consensus/storage_power_actor.md:dashboardState:   wip
./systems/filecoin_blockchain/storage_power_consensus/_index.md:dashboardState:                wip
./systems/filecoin_blockchain/struct/chain/_index.md:dashboardState:                           incorrect
./systems/filecoin_blockchain/struct/chain_manager/_index.md:dashboardState:                   incorrect
./systems/filecoin_blockchain/struct/block_producer/_index.md:dashboardState:                  incorrect
./systems/filecoin_blockchain/struct/tipset/_index.md:dashboardState:                          wip
./systems/filecoin_blockchain/struct/_index.md:dashboardState:                                 incorrect
./systems/filecoin_blockchain/struct/block/_index.md:dashboardState:                           incorrect
./systems/filecoin_blockchain/chainsync/_index.md:dashboardState:                              reliable
./systems/filecoin_blockchain/_index.md:dashboardState:                                        wip
./systems/filecoin_blockchain/message_pool/message_storage.md:dashboardState:                  stable
./systems/filecoin_blockchain/message_pool/message_syncer.md:dashboardState:                   stable
./systems/filecoin_blockchain/message_pool/_index.md:dashboardState:                           stable
./systems/filecoin_nodes/repository/config/_index.md:dashboardState:                           wip
./systems/filecoin_nodes/repository/ipldstore/_index.md:dashboardState:                        wip
./systems/filecoin_nodes/repository/key_store/_index.md:dashboardState:                        wip
./systems/filecoin_nodes/repository/_index.md:dashboardState:                                  wip
./systems/filecoin_nodes/network/_index.md:dashboardState:                                     wip
./systems/filecoin_nodes/node_types/retrieval_miner_node.md:dashboardState:                    wip
./systems/filecoin_nodes/node_types/relayer_node.md:dashboardState:                            wip
./systems/filecoin_nodes/node_types/node.md:dashboardState:                                    wip
./systems/filecoin_nodes/node_types/verifier_node.md:dashboardState:                           wip
./systems/filecoin_nodes/node_types/node_types.md:dashboardState:                              wip
./systems/filecoin_nodes/node_types/storage_miner_node.md:dashboardState:                      wip
./systems/filecoin_nodes/node_types/_index.md:dashboardState:                                  wip
./systems/filecoin_nodes/node_types/client_node.md:dashboardState:                             wip
./systems/filecoin_nodes/_index.md:dashboardState:                                             wip
./systems/filecoin_nodes/clock/_index.md:dashboardState:                                       wip
./systems/filecoin_token/multisig/multisig_actor.md:dashboardState:                            incorrect
./systems/filecoin_token/multisig/_index.md:dashboardState:                                    incorrect
./systems/filecoin_token/payment_channels/payment_channel_actor.md:dashboardState:             incorrect
./systems/filecoin_token/payment_channels/_index.md:dashboardState:                            wip
./systems/filecoin_token/wallets.md:dashboardState:                                            missing
./systems/filecoin_token/_index.md:dashboardState:                                             incorrect
./systems/filecoin_markets/storage_market/storage_market_actor.md:dashboardState:              incomplete
./systems/filecoin_markets/storage_market/storage_deal/storage_deal_states.md:dashboardState:  wip
./systems/filecoin_markets/storage_market/storage_deal/faults.md:dashboardState:               wip
./systems/filecoin_markets/storage_market/storage_deal/storage_deal_flow.md:dashboardState:    wip
./systems/filecoin_markets/storage_market/storage_deal/_index.md:dashboardState:               wip
./systems/filecoin_markets/storage_market/storage_client.md:dashboardState:                    incomplete
./systems/filecoin_markets/storage_market/storage_provider.md:dashboardState:                  wip
./systems/filecoin_markets/storage_market/_index.md:dashboardState:                            incomplete
./systems/filecoin_markets/retrieval_market/retrieval_provider.md:dashboardState:              stable
./systems/filecoin_markets/retrieval_market/retrieval_peer_resolver.md:dashboardState:         stable
./systems/filecoin_markets/retrieval_market/retrieval_protocols.md:dashboardState:             stable
./systems/filecoin_markets/retrieval_market/retrieval_client.md:dashboardState:                stable
./systems/filecoin_markets/retrieval_market/deal_status.md:dashboardState:                     stable
./systems/filecoin_markets/retrieval_market/_index.md:dashboardState:                          stable
./systems/filecoin_markets/_index.md:dashboardState:                                           wip
./systems/filecoin_vm/interpreter/_index.md:dashboardState:                                    wip
./systems/filecoin_vm/sysactors/reward_actor.md:dashboardState:                                wip
./systems/filecoin_vm/sysactors/init_actor.md:dashboardState:                                  wip
./systems/filecoin_vm/sysactors/cron_actor.md:dashboardState:                                  wip
./systems/filecoin_vm/sysactors/account_actor.md:dashboardState:                               wip
./systems/filecoin_vm/sysactors/_index.md:dashboardState:                                      wip
./systems/filecoin_vm/runtime/gascost/_index.md:dashboardState:                                incomplete
./systems/filecoin_vm/runtime/_index.md:dashboardState:                                        wip
./systems/filecoin_vm/message/_index.md:dashboardState:                                        stable
./systems/filecoin_vm/state_tree/_index.md:dashboardState:                                     wip
./systems/filecoin_vm/actor/_index.md:dashboardState:                                          wip
./systems/filecoin_vm/_index.md:dashboardState:                                                wip
./systems/_index.md:dashboardState:                                                            wip
yiannisbot commented 4 years ago

@olizilla:

for dashboardAudit 0 is still in use in a bunch. These should be set to missing

Sections appendix, listings, glossary, libraries have not been looked at yet from the content perspective, hence, I didn't change the dashboard values in the previous PR (https://github.com/filecoin-project/specs/pull/1074). I wouldn't mind excluding those from the dashboard for now, given that they're not core parts of the spec. I also don't mind updating them if you think we should do this now.

olizilla commented 4 years ago

@yiannisbot am completing the ask on this issue make sure all the files use the new labels

olizilla commented 4 years ago

is done in #1083

olizilla commented 4 years ago

Sections appendix, listings, glossary, libraries have not been looked at yet from the content perspective, hence, I didn't change the dashboard values in the previous PR (#1074). I wouldn't mind excluding those from the dashboard for now, given that they're not core parts of the spec

@yiannisbot i am happy to do that, but lets check with @daviddias first.