Documentation #38934
"Developer Guide" appears two times in table of contents
% Done:
0%
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:
Description
This is the expanded table of content of http://docs.ceph.com/docs/master/dev/ clearly showing the developer guide two times.
- **Intro to Ceph** - **Installation (ceph-deploy)** - **Installation (Manual)** - **Installation (Kubernetes + Helm)** - **Ceph Storage Cluster** - **Ceph Filesystem** - **Ceph Block Device** - **Ceph Object Gateway** - **Ceph Manager Daemon** - **Ceph Dashboard** - **API Documentation** - **Architecture** - **Developer Guide** - **Introduction** - **Essentials (tl;dr)** - **Leads** - **History** - **Licensing** - **Source code repositories** - **Redmine issue tracker** - **Mailing list** - **IRC** - **Submitting patches** - **Building from source** - **Using ccache to speed up local builds** - **Development-mode cluster** - **Kubernetes/Rook development cluster** - **Backporting** - **Guidance for use of cluster log** - **What is merged where and when ?** - **Development releases (i.e. x.0.z)** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable release candidates (i.e. x.1.z) phase 1** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable release candidates (i.e. x.1.z) phase 2** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable releases (i.e. x.2.z)** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Issue tracker** - **Issue tracker conventions** - **Basic workflow** - **Update the tracker** - **Upstream code** - **Local environment** - **Bugfix branch** - **Fix bug locally** - **GitHub pull request** - **Automated PR validation** - **Notes on PR make check test** - **Integration tests AKA ceph-qa-suite** - **Code review** - **Amending your PR** - **Merge** - **Testing** - **Unit tests - make check** - **How unit tests are declared** - **Unit testing of CLI tools** - **Caveats** - **Integration tests** - **Teuthology consumes packages** - **The nightlies** - **Suites inventory** - **teuthology-describe-tests** - **How integration tests are run** - **How integration tests are defined** - **Reading a standalone test** - **Test descriptions** - **How are tests built from directories?** - **Convolution operator** - **Concatenation operator** - **Filtering tests by their description** - **Reducing the number of tests** - **Testing in the cloud** - **Assumptions and caveat** - **Prepare tenant** - **Getting ceph-workbench** - **Linking ceph-workbench with your OpenStack tenant** - **Run the dummy suite** - **Run a standalone test** - **Interrupt a running suite** - **Upload logs to archive server** - **Provision VMs ad hoc** - **Deploy a cluster for manual testing** - **Testing - how to run s3-tests locally** - **Step 1 - build Ceph** - **Step 2 - vstart** - **Step 3 - run s3-tests** - **Ceph Internals** - **Tracing Ceph With Blkin** - **BlueStore Internals** - **Cache pool** - **A Detailed Documentation on How to Set up Ceph Kerberos Authentication** - **CephFS Reclaim Interface** - **CephFS Snapshots** - **Cephx** - **A Detailed Description of the Cephx Authentication Protocol** - **Configuration Management System** - **config-key layout** - **CephContext** - **Corpus structure** - **Installing Oprofile** - **C++17 and libstdc++ ABI** - **CephFS delayed deletion** - **Deploying a development cluster** - **Deploying multiple development clusters on the same machine** - **Development workflows** - **Documenting Ceph** - **Serialization (encode/decode)** - **Erasure Coded pool** - **File striping** - **FreeBSD Implementation details** - **Building Ceph Documentation** - **IANA Numbers** - **Contributing to Ceph: A Guide for Developers** - **Introduction** - **Essentials (tl;dr)** - **Leads** - **History** - **Licensing** - **Source code repositories** - **Redmine issue tracker** - **Mailing list** - **IRC** - **Submitting patches** - **Building from source** - **Using ccache to speed up local builds** - **Development-mode cluster** - **Kubernetes/Rook development cluster** - **Backporting** - **Guidance for use of cluster log** - **What is merged where and when ?** - **Development releases (i.e. x.0.z)** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable release candidates (i.e. x.1.z) phase 1** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable release candidates (i.e. x.1.z) phase 2** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Stable releases (i.e. x.2.z)** - **What ?** - **Where ?** - **When ?** - **Branch merges** - **Issue tracker** - **Issue tracker conventions** - **Basic workflow** - **Update the tracker** - **Upstream code** - **Local environment** - **Bugfix branch** - **Fix bug locally** - **GitHub pull request** - **Automated PR validation** - **Notes on PR make check test** - **Integration tests AKA ceph-qa-suite** - **Code review** - **Amending your PR** - **Merge** - **Testing** - **Unit tests - make check** - **How unit tests are declared** - **Unit testing of CLI tools** - **Caveats** - **Integration tests** - **Teuthology consumes packages** - **The nightlies** - **Suites inventory** - **teuthology-describe-tests** - **How integration tests are run** - **How integration tests are defined** - **Reading a standalone test** - **Test descriptions** - **How are tests built from directories?** - **Convolution operator** - **Concatenation operator** - **Filtering tests by their description** - **Reducing the number of tests** - **Testing in the cloud** - **Assumptions and caveat** - **Prepare tenant** - **Getting ceph-workbench** - **Linking ceph-workbench with your OpenStack tenant** - **Run the dummy suite** - **Run a standalone test** - **Interrupt a running suite** - **Upload logs to archive server** - **Provision VMs ad hoc** - **Deploy a cluster for manual testing** - **Testing - how to run s3-tests locally** - **Step 1 - build Ceph** - **Step 2 - vstart** - **Step 3 - run s3-tests** - **Kernel client troubleshooting (FS)** - **Hacking on Ceph in Kubernetes with Rook** - **Library architecture** - **Use of the cluster log** - **Debug logs** - **build on MacOS** - **Messenger notes** - **Monitor bootstrap** - **ON-DISK FORMAT** - **FULL OSDMAP VERSION PRUNING** - **msgr2 protocol** - **Network Encoding** - **Network Protocol** - **Object Store Architecture Overview** - **OSD class path issues** - **Peering** - **Using perf** - **Perf counters** - **Perf histograms** - **PG (Placement Group) notes** - **Developer Guide (Quick)** - **RADOS client protocol** - **RBD Incremental Backup** - **RBD Export & Import** - **RBD Layering** - **Ceph Release Process** - **Notes on Ceph repositories** - **SeaStore** - **Sepia community test lab** - **Session Authentication for the Cephx Protocol** - **Testing notes** - **Public OSD Version** - **Wireshark Dissector** - **OSD developer documentation** - **MDS developer documentation** - **RADOS Gateway developer documentation** - **ceph-volume developer documentation** - **Governance** - **ceph-volume** - **Ceph Releases** - **Glossary**
First failed attempt to fix this: https://github.com/ceph/ceph/pull/27120
History
#1 Updated by Nathan Cutler about 5 years ago
- Status changed from New to In Progress
- Assignee set to Nathan Cutler
#2 Updated by Nathan Cutler about 5 years ago
Introduced by ef3ac5692b7eb79ec93537b612100ce3ed7f767b
#3 Updated by Nathan Cutler about 5 years ago
- Pull request ID set to 27159
#4 Updated by Nathan Cutler about 5 years ago
- Status changed from In Progress to Fix Under Review
#5 Updated by Dan Mick about 5 years ago
I don't understand why this is a problem.
#6 Updated by Nathan Cutler about 5 years ago
- Status changed from Fix Under Review to Resolved
#7 Updated by Nathan Cutler about 5 years ago
- Subject changed from "Developer Documentation" appears two times in table of contents to "Developer Guide" appears two times in table of contents