Skip to content

Commit c0e4d5e

Browse files
authored
Merge pull request #1565 from croth1/link_cleanup
[WIP] Clean up broken bits and links in the docs
2 parents b90dcb3 + 49f2e2e commit c0e4d5e

File tree

11 files changed

+23
-35
lines changed

11 files changed

+23
-35
lines changed

src/maintainer/infrastructure.rst

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Smithy contains maintenance code for conda-forge, which is used by the ``conda-s
2525

2626
``conda-smithy`` also contains the command line tool that you should use if you rerender manually from the command line (see :ref:`dev_update_rerender`).
2727

28-
Smithy can be used beyond Conda-Forge's purposes. For example, it can be used to `set up self-hosted Azure agents <self-hosted_azure-config>`__ for non-Conda-Forge infrastructures.
28+
Smithy can be used beyond Conda-Forge's purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-Conda-Forge infrastructures.
2929
(You could also consider using `Azure virtual machine scale set agents <https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/scale-set-agents?view=azure-devops>`_,
3030
which could be less expensive to run than permanently active agents.)
3131

@@ -210,8 +210,8 @@ TravisCI (OSX, IBM Power 8+)
210210
------------------------------
211211

212212
TravisCI is used to build packages for IBM Power 8+. After merging a staged-recipes pull request, it might be necessary to
213-
force sync your repositories in TravisCI to see the reload and cancel buttons. To do this please visit `<https://travis-ci.com/profile>`_
214-
and click "Sync accounts".
213+
force sync your repositories in TravisCI to see the reload and cancel buttons. To do this please visit `<https://app.travis-ci.com/account/repositories>`__
214+
and click the "Sync accounts" button.
215215

216216
Enabling Travis
217217
...............
@@ -254,15 +254,8 @@ CircleCI for OSX should be used for OSX, only when TravisCI resources (50 minute
254254
Note that you need to rerender the feedstock, once this change has been made.
255255

256256

257-
Enabling Circle on your Fork
258-
............................
259-
260-
If for some reason CircleCI is not triggering build from forks,
261-
Circle can be manually added for each fork. Circle calls this "Adding a Project" and
262-
`the official CircleCI documentation is available here <https://circleci.com/docs/getting-started/#add-and-follow-more-projects>`__.
263-
This effectively amounts to going to the `Add Projects <https://circleci.com/add-projects>`__
264-
page, finding the fork that you wish to enable, and clicking the "Build Project" button.
265-
This is not normally needed.
257+
Debugging permission errors
258+
...........................
266259

267260
If CircleCI lacks permissions to checkout the source code, it will produce an error as follows::
268261

@@ -271,7 +264,7 @@ If CircleCI lacks permissions to checkout the source code, it will produce an er
271264
Permission denied (publickey).
272265
fatal: Could not read from remote repository.
273266

274-
When this happens for a feedstock, it can be fixed using the `webservice <https://conda-forge.org/docs/webservice.html#conda-forge-admin-please-update-circle>`__, by posting the following comment::
267+
When this happens for a feedstock, it can be fixed using the `webservice <ci_update_circle>`, by posting the following comment::
275268

276269
@conda-forge-admin, please update circle
277270

src/maintainer/knowledge_base.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,18 +124,15 @@ compiled libraries used in Python, `as described on this Python wiki page
124124
<https://wiki.python.org/moin/WindowsCompilers>`__. The current relevant
125125
versions are:
126126

127-
* For Python 2.7: Visual C++ 9.0
128127
* For Python 3.5–3.7: Visual C++ 14.0
129128

130129
While you can obtain these tools by installing the right version of the full
131130
`Visual Studio <https://visualstudio.microsoft.com/>`__ development
132131
environment, you can save a lot of time and bandwidth by installing standalone
133132
“build tools” packages. The links are as follows:
134133

135-
* For Python 2.7: `Microsoft Visual C++ Compiler for Python 2.7
136-
<https://www.microsoft.com/download/details.aspx?id=44266>`__.
137134
* For Python 3.5–3.7: `Microsoft Build Tools for Visual Studio 2017
138-
<https://www.visualstudio.com/downloads/#build-tools-for-visual-studio-2017>`__.
135+
<https://visualstudio.microsoft.com/vs/older-downloads/#visual-studio-2017-and-other-products>`__.
139136

140137
If you need more information. Please refer `the Python wiki page on Windows compilers
141138
<https://wiki.python.org/moin/WindowsCompilers>`__.

src/maintainer/maintainer_faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ FAQ
148148
149149
150150
151-
This comes from the CI environment being headless and can be fixed by adding the ``QT_QPA_PLATFORM=offscreen`` `environment variable <https://docs.conda.io/projects/conda-build/en/latest/user-guide/environment-variables.html#inherited-environment-variabless>`_.
151+
This comes from the CI environment being headless and can be fixed by adding the ``QT_QPA_PLATFORM=offscreen`` `environment variable <https://docs.conda.io/projects/conda-build/en/latest/user-guide/environment-variables.html#inherited-environment-variables>`__.
152152
The variable can either be added directly to the test command or provided in the `meta.yaml <https://conda-forge.org/docs/maintainer/adding_pkgs.html#the-recipe-meta-yaml>`__ like so:
153153

154154
.. code-block:: yaml

src/maintainer/pinning_deps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,6 @@ be added by hand. To do this, follow these steps:
118118
- Bump the version in meta.yaml to the current date
119119

120120
Details of how the migration yaml is setup are provided in an `example <https://github.com/conda-forge/conda-forge-pinning-feedstock/tree/master/recipe/migrations/example.exyaml>`__
121-
and documentation `here <https://regro.github.io/cf-scripts/migrators.html#building-a-migration-yaml>`_.
121+
and documentation `here <https://regro.github.io/cf-scripts/migrators.html#making-migrators>`_.
122122

123123
.. _conda-forge/conda-forge-pinning-feedstock: https://github.com/conda-forge/conda-forge-pinning-feedstock

src/misc/00_intro.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Glossary
77
.. glossary::
88

99
CI
10-
**C**\ ontinuous **I**\ ntegration. Continuous integration is the practice of automating the integration of code changes from multiple contributors into a single software project. `Learn More <https://en.wikipedia.org/wiki/Continuous_integration/>`__.
10+
**C**\ ontinuous **I**\ ntegration. Continuous integration is the practice of automating the integration of code changes from multiple contributors into a single software project. `Learn More <https://en.wikipedia.org/wiki/Continuous_integration>`__.
1111

1212
PR
1313
**P**\ ull **R**\ equest. Pull Request is a workflow method to submit contributions to an open development project in which the developer asks for changes committed to an external repository to be considered for inclusion in a project's main repository. `Learn More <https://help.github.com/articles/about-pull-requests/>`__.
1414

1515
CDT
16-
**C**\ ore **D**\ ependency **T**\ ree. Core Dependency Tree packages take care of the dependencies which are so close to the system that they are not packaged with ``conda-forge``. A CDT package consists of repackaged CentOS binaries from the appropriate version, either 6 or 7 depending on user choice and platform. `Learn More <https://conda-forge.org/docs/maintainer/knowledge_base.html#core-dependency-tree-packages-cdts/>`__.
16+
**C**\ ore **D**\ ependency **T**\ ree. Core Dependency Tree packages take care of the dependencies which are so close to the system that they are not packaged with ``conda-forge``. A CDT package consists of repackaged CentOS binaries from the appropriate version, either 6 or 7 depending on user choice and platform. :ref:`Learn more<cdt_packages>`.
1717

1818
ABI
1919
**A**\ pplication **B**\ inary **I**\ nterface. ABI is a document that comprehensively defines the binary system interface between applications and the operating system on which they run. `Learn More <https://en.wikipedia.org/wiki/Application_binary_interface>`__.
@@ -31,5 +31,3 @@ TODO list
3131
*********
3232

3333
.. todolist::
34-
35-
The original entry is located in ``.src`` file of `/home/runner/work/conda-forge.github.io/conda-forge.github.io/src/maintainer/knowledge_base.rst, line 952. <https://github.com/conda-forge/conda-forge.github.io/blob/main/src/maintainer/knowledge_base.rst#noarch-generic/>`__.

src/orga/governance.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ Standard items are ones where public record and discourse is
8686
preferable. Sensitive voting items are ones where the results of the
8787
vote should remain private to the voters after the vote has occurred.
8888
Sensitive votes should take place on a secure anonymous voting platform
89-
in order to retain election integrity and anonymity. (We have used `Polys <polys.me>`_
90-
and `the Helios voting system <https://vote.heliosvoting.org/>`_, but are
89+
in order to retain election integrity and anonymity. (We have used `Polys <https://polys.me>`__
90+
and `the Helios voting system <https://vote.heliosvoting.org/>`__, but are
9191
open to any secure, anonymous system.) The email capability of your chosen
9292
voting platform should be used for sending voting invitations and reminders,
9393
and you should use the email list from
@@ -114,7 +114,7 @@ To call for a standard vote, here is a template PR comment:
114114

115115
:Posting results: To maintain the historical record, the outcome of any standard vote which invokes the
116116
"time out" rules below should be recorded in the "vote-results" folder at
117-
https://github.com/conda-forge/conda-forge.github.io/tree/main/src/vote-results
117+
https://github.com/conda-forge/conda-forge.github.io/tree/main/vote-results
118118

119119
Each vote should be its own file. The filename should reflect the topic and the
120120
date that the vote opened. The file should contain at least:
@@ -187,8 +187,8 @@ To call for a standard vote, here is a template PR comment:
187187
188188
To declare a standard vote "timed out," the person making such a declaration
189189
must post a pull-request adding
190-
a vote record to the https://github.com/conda-forge/conda-forge.github.io/tree/main/src/vote-results
191-
folder. The declaration PR should be merged by the first core member
190+
a vote record to the `vote-results folder <https://github.com/conda-forge/conda-forge.github.io/tree/main/vote-results>`__.
191+
The declaration PR should be merged by the first core member
192192
who is available to verify that
193193
the requirements for the timeout have been met, based on their
194194
own personal records.

src/orga/minutes/2017-11-16.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Scheduled time: 9 AM central. Meeting link: https://anaconda.webex.com/anaconda-en/j.php?MTID=m11b5ddad66325da22bbe58d7d1c02809
33

44

5-
# Adopting Anaconda compilers
5+
## Adopting Anaconda compilers
66
- Linux: gcc 7.2
77
- Prefixed compilers: require activation
88
- Common adaptations required for new anaconda compilers:
@@ -20,7 +20,7 @@ Scheduled time: 9 AM central. Meeting link: https://anaconda.webex.com/anaconda
2020
import os
2121

2222
print("Hello World")
23-
# Compiler flag unification
23+
## Compiler flag unification
2424
- GCC
2525
- toolchain: https://github.com/conda-forge/toolchain-feedstock/blob/master/recipe/activate.sh
2626
- toolchain3: https://github.com/conda-forge/toolchain3-feedstock/blob/master/recipe/activate.sh
@@ -65,7 +65,7 @@ Filipe: this is really little more than a vendor change. We already depend on o
6565

6666
Need to maintain llvm with cling patches, but this will not be the default compiler.
6767

68-
# Conda-build 3: strategy for moving
68+
## Conda-build 3: strategy for moving
6969
- install and use with c-b-a (no cb3 matrix)
7070
- Waiting on feedback from issue https://github.com/conda-tools/conda-build-all/issues/94 but mostly seems OK.
7171
- Mike: needs to fix —skip-existing. Concern is that re-rendering should not generate new packages when only some dependency has changed (bugfix bump?)
@@ -82,13 +82,13 @@ Need to maintain llvm with cling patches, but this will not be the default compi
8282
- People generally interested, but needs to be implemented and proven over time. Good experience so far with defaults.
8383

8484

85-
# Fortran support on Windows
85+
## Fortran support on Windows
8686
- gfortran (msys2) / Flang
8787
- Timeline for adding either
8888
- Mike asked that whatever is done is done with community approval, for the sake of maintaining a high quality user experience.
8989

9090

91-
# OpenMP behavior
91+
## OpenMP behavior
9292
- Currently, needs extra package on mac, but is included on Linux (not active in flags, though)
9393
- What is desirable default behavior?
9494

src/orga/minutes/2019-07-24.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 2017-07-24 conda-forge core meeting
1+
# 2019-07-24 conda-forge core meeting
22

33
[HackMD link](https://hackmd.io/P8on5P8wR3q3WslwrJzOEg)
44
## Attendees

src/orga/minutes/2019-08-07.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 2017-08-07 conda-forge core meeting
1+
# 2019-08-07 conda-forge core meeting
22

33
[HackMD link](https://hackmd.io/1VB13FnIQpiruA0lb04MKw?edit)
44

File renamed without changes.

0 commit comments

Comments
 (0)